Struct Aligned

pub struct Aligned<A: Alignment, T> { /* private fields */ }

Wrapper type that aligns T to at least Alignment It adds no size to the layout of the struct if the size is a multiple of the alignment, otherwise the size is rounded up to the next multiple of the alignment

assert_eq!(size_of::<Aligned<A16, u8>>(), size_of::<A16>());
assert_eq!(size_of::<Aligned<A256, [u8; 256]>>(), size_of::<[u8; 256]>());
assert_eq!(size_of::<Aligned<A512, [u8; 81920]>>(), size_of::<[u8; 81920]>());

Implementations

impl<A: Alignment, T> Aligned<A, T>

pub fn new(t: T) -> Self

Creates a new instance of Aligned

pub fn into_inner(self) -> T

Consumes Aligned and returns the wrapped value

Trait Implementations

impl<A: Alignment, T> AsMut<T> for Aligned<A, T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<A: Alignment, T> AsRef<T> for Aligned<A, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<A: Clone + Alignment, T: Clone> Clone for Aligned<A, T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Alignment, T: Debug> Debug for Aligned<A, T>

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

Formats the value using the given formatter.

impl<A: Default + Alignment, T: Default> Default for Aligned<A, T>

fn default() -> Aligned<A, T>

Returns the “default value” for a type.

impl<A: Alignment, T> Deref for Aligned<A, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<A: Alignment, T> DerefMut for Aligned<A, T>

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

Mutably dereferences the value.

impl<A: Alignment, T> From<T> for Aligned<A, T>

fn from(t: T) -> Self

Converts to this type from the input type.

impl<A: Hash + Alignment, T: Hash> Hash for Aligned<A, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A: Ord + Alignment, T: Ord> Ord for Aligned<A, T>

fn cmp(&self, other: &Aligned<A, T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<A: PartialEq + Alignment, T: PartialEq> PartialEq for Aligned<A, T>

fn eq(&self, other: &Aligned<A, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<A: PartialOrd + Alignment, T: PartialOrd> PartialOrd for Aligned<A, T>

fn partial_cmp(&self, other: &Aligned<A, T>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<A: Copy + Alignment, T: Copy> Copy for Aligned<A, T>

impl<A: Eq + Alignment, T: Eq> Eq for Aligned<A, T>

impl<A: Alignment, T> StructuralPartialEq for Aligned<A, T>