Union alignas::AlignAs

#[repr(C)]
pub union AlignAs<T: Copy, A: Copy> {
    // some fields omitted
}

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) });

Methods

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

pub fn new(t: T) -> Self

Put the given T object into an aligned location

Trait Implementations

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

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

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

Mutably dereferences the value.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn default() -> Self

Returns the "default value" for a type.