aboutsummaryrefslogtreecommitdiff
path: root/vendor/bytemuck/src/must.rs
diff options
context:
space:
mode:
authorValentin Popov <valentin@popov.link>2024-07-19 15:37:58 +0300
committerValentin Popov <valentin@popov.link>2024-07-19 15:37:58 +0300
commita990de90fe41456a23e58bd087d2f107d321f3a1 (patch)
tree15afc392522a9e85dc3332235e311b7d39352ea9 /vendor/bytemuck/src/must.rs
parent3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd (diff)
downloadfparkan-a990de90fe41456a23e58bd087d2f107d321f3a1.tar.xz
fparkan-a990de90fe41456a23e58bd087d2f107d321f3a1.zip
Deleted vendor folder
Diffstat (limited to 'vendor/bytemuck/src/must.rs')
-rw-r--r--vendor/bytemuck/src/must.rs203
1 files changed, 0 insertions, 203 deletions
diff --git a/vendor/bytemuck/src/must.rs b/vendor/bytemuck/src/must.rs
deleted file mode 100644
index 8373e71..0000000
--- a/vendor/bytemuck/src/must.rs
+++ /dev/null
@@ -1,203 +0,0 @@
-#![allow(clippy::module_name_repetitions)]
-#![allow(clippy::let_unit_value)]
-#![allow(clippy::let_underscore_untyped)]
-#![allow(clippy::ptr_as_ptr)]
-
-use crate::{AnyBitPattern, NoUninit};
-use core::mem::{align_of, size_of};
-
-struct Cast<A, B>((A, B));
-impl<A, B> Cast<A, B> {
- const ASSERT_ALIGN_GREATER_THAN_EQUAL: () =
- assert!(align_of::<A>() >= align_of::<B>());
- const ASSERT_SIZE_EQUAL: () = assert!(size_of::<A>() == size_of::<B>());
- const ASSERT_SIZE_MULTIPLE_OF: () = assert!(
- (size_of::<A>() == 0) == (size_of::<B>() == 0)
- && (size_of::<A>() % size_of::<B>() == 0)
- );
-}
-
-// Workaround for https://github.com/rust-lang/miri/issues/2423.
-// Miri currently doesn't see post-monomorphization errors until runtime,
-// so `compile_fail` tests relying on post-monomorphization errors don't
-// actually fail. Instead use `should_panic` under miri as a workaround.
-#[cfg(miri)]
-macro_rules! post_mono_compile_fail_doctest {
- () => {
- "```should_panic"
- };
-}
-#[cfg(not(miri))]
-macro_rules! post_mono_compile_fail_doctest {
- () => {
- "```compile_fail,E0080"
- };
-}
-
-/// Cast `A` into `B` if infalliable, or fail to compile.
-///
-/// Note that for this particular type of cast, alignment isn't a factor. The
-/// input value is semantically copied into the function and then returned to a
-/// new memory location which will have whatever the required alignment of the
-/// output type is.
-///
-/// ## Failure
-///
-/// * If the types don't have the same size this fails to compile.
-///
-/// ## Examples
-/// ```
-/// // compiles:
-/// let bytes: [u8; 2] = bytemuck::must_cast(12_u16);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// // fails to compile (size mismatch):
-/// let bytes : [u8; 3] = bytemuck::must_cast(12_u16);
-/// ```
-#[inline]
-pub fn must_cast<A: NoUninit, B: AnyBitPattern>(a: A) -> B {
- let _ = Cast::<A, B>::ASSERT_SIZE_EQUAL;
- unsafe { transmute!(a) }
-}
-
-/// Convert `&A` into `&B` if infalliable, or fail to compile.
-///
-/// ## Failure
-///
-/// * If the target type has a greater alignment requirement.
-/// * If the source type and target type aren't the same size.
-///
-/// ## Examples
-/// ```
-/// // compiles:
-/// let bytes: &[u8; 2] = bytemuck::must_cast_ref(&12_u16);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// // fails to compile (size mismatch):
-/// let bytes : &[u8; 3] = bytemuck::must_cast_ref(&12_u16);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// // fails to compile (alignment requirements increased):
-/// let bytes : &u16 = bytemuck::must_cast_ref(&[1u8, 2u8]);
-/// ```
-#[inline]
-pub fn must_cast_ref<A: NoUninit, B: AnyBitPattern>(a: &A) -> &B {
- let _ = Cast::<A, B>::ASSERT_SIZE_EQUAL;
- let _ = Cast::<A, B>::ASSERT_ALIGN_GREATER_THAN_EQUAL;
- unsafe { &*(a as *const A as *const B) }
-}
-
-/// Convert a `&mut A` into `&mut B` if infalliable, or fail to compile.
-///
-/// As [`must_cast_ref`], but `mut`.
-///
-/// ## Examples
-/// ```
-/// let mut i = 12_u16;
-/// // compiles:
-/// let bytes: &mut [u8; 2] = bytemuck::must_cast_mut(&mut i);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// # let mut bytes: &mut [u8; 2] = &mut [1, 2];
-/// // fails to compile (alignment requirements increased):
-/// let i : &mut u16 = bytemuck::must_cast_mut(bytes);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// # let mut i = 12_u16;
-/// // fails to compile (size mismatch):
-/// let bytes : &mut [u8; 3] = bytemuck::must_cast_mut(&mut i);
-/// ```
-#[inline]
-pub fn must_cast_mut<
- A: NoUninit + AnyBitPattern,
- B: NoUninit + AnyBitPattern,
->(
- a: &mut A,
-) -> &mut B {
- let _ = Cast::<A, B>::ASSERT_SIZE_EQUAL;
- let _ = Cast::<A, B>::ASSERT_ALIGN_GREATER_THAN_EQUAL;
- unsafe { &mut *(a as *mut A as *mut B) }
-}
-
-/// Convert `&[A]` into `&[B]` (possibly with a change in length) if
-/// infalliable, or fail to compile.
-///
-/// * `input.as_ptr() as usize == output.as_ptr() as usize`
-/// * `input.len() * size_of::<A>() == output.len() * size_of::<B>()`
-///
-/// ## Failure
-///
-/// * If the target type has a greater alignment requirement.
-/// * If the target element type doesn't evenly fit into the the current element
-/// type (eg: 3 `u16` values is 1.5 `u32` values, so that's a failure).
-/// * Similarly, you can't convert between a [ZST](https://doc.rust-lang.org/nomicon/exotic-sizes.html#zero-sized-types-zsts)
-/// and a non-ZST.
-///
-/// ## Examples
-/// ```
-/// let indicies: &[u16] = &[1, 2, 3];
-/// // compiles:
-/// let bytes: &[u8] = bytemuck::must_cast_slice(indicies);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// # let bytes : &[u8] = &[1, 0, 2, 0, 3, 0];
-/// // fails to compile (bytes.len() might not be a multiple of 2):
-/// let byte_pairs : &[[u8; 2]] = bytemuck::must_cast_slice(bytes);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// # let byte_pairs : &[[u8; 2]] = &[[1, 0], [2, 0], [3, 0]];
-/// // fails to compile (alignment requirements increased):
-/// let indicies : &[u16] = bytemuck::must_cast_slice(byte_pairs);
-/// ```
-#[inline]
-pub fn must_cast_slice<A: NoUninit, B: AnyBitPattern>(a: &[A]) -> &[B] {
- let _ = Cast::<A, B>::ASSERT_SIZE_MULTIPLE_OF;
- let _ = Cast::<A, B>::ASSERT_ALIGN_GREATER_THAN_EQUAL;
- let new_len = if size_of::<A>() == size_of::<B>() {
- a.len()
- } else {
- a.len() * (size_of::<A>() / size_of::<B>())
- };
- unsafe { core::slice::from_raw_parts(a.as_ptr() as *const B, new_len) }
-}
-
-/// Convert `&mut [A]` into `&mut [B]` (possibly with a change in length) if
-/// infalliable, or fail to compile.
-///
-/// As [`must_cast_slice`], but `&mut`.
-///
-/// ## Examples
-/// ```
-/// let mut indicies = [1, 2, 3];
-/// let indicies: &mut [u16] = &mut indicies;
-/// // compiles:
-/// let bytes: &mut [u8] = bytemuck::must_cast_slice_mut(indicies);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// # let mut bytes = [1, 0, 2, 0, 3, 0];
-/// # let bytes : &mut [u8] = &mut bytes[..];
-/// // fails to compile (bytes.len() might not be a multiple of 2):
-/// let byte_pairs : &mut [[u8; 2]] = bytemuck::must_cast_slice_mut(bytes);
-/// ```
-#[doc = post_mono_compile_fail_doctest!()]
-/// # let mut byte_pairs = [[1, 0], [2, 0], [3, 0]];
-/// # let byte_pairs : &mut [[u8; 2]] = &mut byte_pairs[..];
-/// // fails to compile (alignment requirements increased):
-/// let indicies : &mut [u16] = bytemuck::must_cast_slice_mut(byte_pairs);
-/// ```
-#[inline]
-pub fn must_cast_slice_mut<
- A: NoUninit + AnyBitPattern,
- B: NoUninit + AnyBitPattern,
->(
- a: &mut [A],
-) -> &mut [B] {
- let _ = Cast::<A, B>::ASSERT_SIZE_MULTIPLE_OF;
- let _ = Cast::<A, B>::ASSERT_ALIGN_GREATER_THAN_EQUAL;
- let new_len = if size_of::<A>() == size_of::<B>() {
- a.len()
- } else {
- a.len() * (size_of::<A>() / size_of::<B>())
- };
- unsafe { core::slice::from_raw_parts_mut(a.as_mut_ptr() as *mut B, new_len) }
-}