Struct Align

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

Expand description

A zero-sized-type aligned to N. Compound types containing a field Align<N> with have an alignment of at least N.

use elain::Align;
use core::mem::{align_of, align_of_val};

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

const FOO_ALIGN: usize = 8;

#[repr(C)]
struct Foo {
    _align: Align<FOO_ALIGN>,
}

let foo: Foo = Foo { _align: Align::NEW };

assert_eq!(align_of_val(&foo), 8);

Implementations§

impl<const N: usize> Align<N>
where Self: Alignment,

pub const NEW: Self

An instance of Align<N>.

use elain::Align;
use core::mem::{align_of, align_of_val};

#[repr(C)]
struct Foo {
    _align: Align<8>,
}

let foo: Foo = Foo { _align: Align::NEW };

assert_eq!(align_of_val(&foo), 8);

Trait Implementations§

impl<const N: usize> Clone for Align<N>
where Self: Alignment,

fn clone(&self) -> Self

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

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. Read more

impl<const N: usize> Default for Align<N>
where Self: Alignment,

fn default() -> Self

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

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. 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

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. 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

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 ==.

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.

impl<const N: usize> PartialOrd for Align<N>
where Self: Alignment,

fn partial_cmp(&self, _: &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

impl Alignment for Align<1>

impl Alignment for Align<1024>

impl Alignment for Align<1048576>

impl Alignment for Align<128>

impl Alignment for Align<131072>

impl Alignment for Align<134217728>

impl Alignment for Align<16>

impl Alignment for Align<16384>

impl Alignment for Align<16777216>

impl Alignment for Align<2>

impl Alignment for Align<2048>

impl Alignment for Align<2097152>

impl Alignment for Align<256>

impl Alignment for Align<262144>

impl Alignment for Align<268435456>

impl Alignment for Align<32>

impl Alignment for Align<32768>

impl Alignment for Align<33554432>

impl Alignment for Align<4>

impl Alignment for Align<4096>

impl Alignment for Align<4194304>

impl Alignment for Align<512>

impl Alignment for Align<524288>

impl Alignment for Align<536870912>

impl Alignment for Align<64>

impl Alignment for Align<65536>

impl Alignment for Align<67108864>

impl Alignment for Align<8>

impl Alignment for Align<8192>

impl Alignment for Align<8388608>

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,

Auto Trait Implementations§

impl<const N: usize> !Freeze for Align<N>

impl<const N: usize> !RefUnwindSafe for Align<N>

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

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

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

impl<const N: usize> !UnwindSafe for Align<N>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.