AlignAs

Union AlignAs 

Source
pub union AlignAs<T: Copy, A: Copy> {
    /* private fields */
}
Expand description

Wrap an object of type T to give it the alignment requirements of an object of type A.

This has a similar effect to #[repr(align(…))], but is parameterized to support the creation of structures that are generic over alignment.

Example:

extern crate alignas;
use alignas::AlignAs;
use std::{mem, slice};

// put some byte data into the buffer
let mut buffer: AlignAs<_, u64> = AlignAs::new([0u8; 64]);
buffer[3..18].copy_from_slice(b"some input here");

// now do something with it that requires aligned access...
let mut ints = [0u64; 8];
let ptr = &buffer as *const _ as *const u64;
ints.copy_from_slice(unsafe { slice::from_raw_parts(ptr, 8) });

Implementations§

Source§

impl<T: Copy, A: Copy> AlignAs<T, A>

Source

pub fn new(t: T) -> Self

Put the given T object into an aligned location

Trait Implementations§

Source§

impl<T: Copy + Clone + Copy, A: Copy + Clone + Copy> Clone for AlignAs<T, A>

Source§

fn clone(&self) -> AlignAs<T, A>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Copy, A: Copy> Debug for AlignAs<T, A>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: Default + Copy, A: Copy> Default for AlignAs<T, A>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: Copy, A: Copy> Deref for AlignAs<T, A>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<T: Copy, A: Copy> DerefMut for AlignAs<T, A>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl<T: Display + Copy, A: Copy> Display for AlignAs<T, A>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: Hash + Copy, A: Copy> Hash for AlignAs<T, A>

Source§

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: Ord + Copy, A: Copy> Ord for AlignAs<T, A>

Source§

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq + Copy, A: Copy> PartialEq for AlignAs<T, A>

Source§

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd + Copy, A: Copy> PartialOrd for AlignAs<T, A>

Source§

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Copy + Copy, A: Copy + Copy> Copy for AlignAs<T, A>

Source§

impl<T: Eq + Copy, A: Copy> Eq for AlignAs<T, A>

Auto Trait Implementations§

§

impl<T, A> Freeze for AlignAs<T, A>
where T: Freeze, A: Freeze,

§

impl<T, A> RefUnwindSafe for AlignAs<T, A>

§

impl<T, A> Send for AlignAs<T, A>
where T: Send, A: Send,

§

impl<T, A> Sync for AlignAs<T, A>
where T: Sync, A: Sync,

§

impl<T, A> Unpin for AlignAs<T, A>
where T: Unpin, A: Unpin,

§

impl<T, A> UnwindSafe for AlignAs<T, A>
where T: UnwindSafe, A: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.