Struct Align

pub struct Align<const N: usize>(/* private fields */)
where
    Self: Alignment;

A zero-sized type that may be embedded in other types to guarantee an alignment of N bytes. Alignment is provided as a const generic parameter, allowing for better configurability.

assert_eq!(align_of::<Align<1>>(), 1);
assert_eq!(align_of::<Align<2>>(), 2);
assert_eq!(align_of::<Align<4>>(), 4);
// etc..

This can be embedded in types to guarantee the alignment. Ordering will generally matter, as the alignment type must be the first field in the struct.

struct AlignedArray<T, const N: usize>(Align<16>, [T; N]);

let aligned = AlignedArray::<f32, 4>(Align::new(), [0.0, 0.0, 0.0, 0.0]);

assert_eq!(align_of::<Align<1>>(), 1);
assert_eq!(align_of::<Align<2>>(), 2);
assert_eq!(align_of::<Align<4>>(), 4);

Implementations

impl<const N: usize> Align<N>

where Self: Alignment,

pub const fn new() -> Self

Create a new instance of the alignment type.

Trait Implementations

impl<const N: usize> Clone for Align<N>

where Self: Alignment,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Align<N>

where Self: Alignment,

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

Formats the value using the given formatter.

impl<const N: usize> Default for Align<N>

where Self: Alignment,

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Hash for Align<N>

where Self: Alignment,

fn hash<H: Hasher>(&self, _: &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<const N: usize> Ord for Align<N>

where Self: Alignment,

fn cmp(&self, _: &Self) -> 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<const N: usize> PartialEq for Align<N>

where Self: Alignment,

fn eq(&self, other: &Align<N>) -> 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<const N: usize> PartialOrd for Align<N>

where Self: Alignment,

fn partial_cmp(&self, other: &Self) -> 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 Alignment for Align<1>

impl Alignment for Align<1024>

impl Alignment for Align<128>

impl Alignment for Align<16>

impl Alignment for Align<2>

impl Alignment for Align<2048>

impl Alignment for Align<256>

impl Alignment for Align<32>

impl Alignment for Align<4>

impl Alignment for Align<4096>

impl Alignment for Align<512>

impl Alignment for Align<64>

impl Alignment for Align<8>

impl<const N: usize> Copy for Align<N>

where Self: Alignment,

impl<const N: usize> Eq for Align<N>

where Self: Alignment,

impl<const N: usize> StructuralPartialEq for Align<N>

where Self: Alignment,