Struct Alignment 

pub struct Alignment(/* private fields */);

A valid Layout alignment (a power of 2)

Available in named constant forms, which have been #[doc(hidden)] to avoid spam:

Min	Max	Name	Equivalences
ALIGN_1	ALIGN_8192	Byte(s)	8 bits = 1 octect ≈ 1 byte
ALIGN_1_B	ALIGN_8192_B	Byte(s)	8 bits = 1 octect ≈ 1 byte
ALIGN_1_KiB	ALIGN_8192_KiB	Kibibyte(s)	1 KiB = 210 bytes = 10241 bytes
ALIGN_1_MiB	ALIGN_8192_MiB	Mebibyte(s)	1 MiB = 220 bytes = 10242 bytes
ALIGN_1_GiB	ALIGN_8192_GiB	Gibibyte(s)	1 GiB = 230 bytes = 10243 bytes
ALIGN_1_TiB	ALIGN_8192_TiB	Tebibyte(s)	1 TiB = 240 bytes = 10244 bytes
ALIGN_1_EiB	ALIGN_8192_EiB	Exbibyte(s)	1 EiB = 250 bytes = 10245 bytes

Implementations

impl Alignment

pub const MIN: Alignment = ALIGN_1

Minimum representable alignment (e.g. 1)

pub const MAX: Alignment

Maximum representable alignment

Bits	MAX
16	215 B = 32 KiB
32	231 B = 2 GiB
64	263 B = 8 EiB
128	2127 B = ???

pub const fn new(align: usize) -> Option<Self>

Returns None unless align is a valid power of 2 (which also implies nonzero)

pub const fn of<T>() -> Self

Returns the Alignment of T.

pub const unsafe fn new_unchecked(align: usize) -> Self

Undefined behavior unless align is a valid power of 2 (which also implies nonzero)

pub const fn as_usize(self) -> usize

Returns the alignment as a usize (the nicheless underlying type)

pub const fn as_nonzero(self) -> NonZeroUsize

Returns the alignment as a NonZeroUsize

Trait Implementations

impl Clone for Alignment

fn clone(&self) -> Alignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Alignment

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

Formats the value using the given formatter.

impl From<Alignment> for NonZeroUsize

fn from(align: Alignment) -> Self

Converts to this type from the input type.

impl From<Alignment> for usize

fn from(align: Alignment) -> Self

Converts to this type from the input type.

impl From<Layout> for Alignment

fn from(value: Layout) -> Self

Converts to this type from the input type.

impl Hash for Alignment

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 Ord for Alignment

fn cmp(&self, other: &Alignment) -> 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 PartialEq for Alignment

fn eq(&self, other: &Alignment) -> 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 PartialOrd for Alignment

fn partial_cmp(&self, other: &Alignment) -> 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 TryFrom<NonZero<usize>> for Alignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(align: NonZeroUsize) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Alignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(align: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Alignment

impl Eq for Alignment

impl StructuralPartialEq for Alignment