Struct Alignment

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

usize that’s guaranteed to be a power of two (excluding zero).

Implementations

impl Alignment

pub const MIN: Alignment

Minimum alignment.

pub const MAX: Alignment

Maximum alignment.

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

Converts a usize into an Alignment.

pub const unsafe fn new_unchecked(len: usize) -> Alignment

Converts a usize into a DoubledLen without checking for validity.

Safety

Caller must ensure that the given length is a power of two.

pub const fn as_usize(self) -> usize

Converts to a usize.

pub const fn as_nonzero(self) -> NonZeroUsize

Converts to a NonZeroUsize.

pub const fn as_len(self) -> DoubledLen

Converts to a DoubledLen.

pub const fn log2(self) -> u32

Returns the base-2 logarithm of the alignment.

This is always exact.

pub const fn mask(self) -> usize

Returns a usize mask that can be used to check for this alignment.

Trait Implementations

impl Binary for Alignment

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl From<Alignment> for DoubledLen

fn from(align: Alignment) -> DoubledLen

Converts to this type from the input type.

impl From<Alignment> for NonZeroUsize

fn from(align: Alignment) -> NonZeroUsize

Converts to this type from the input type.

impl From<Alignment> for usize

fn from(align: Alignment) -> usize

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

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

Formats the value using the given formatter.

impl Octal for Alignment

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

Formats the value using the given formatter.

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

type Error = ZeroLenError

The type returned in the event of a conversion error.

fn try_from(len: DoubledLen) -> Result<Alignment, ZeroLenError>

Performs the conversion.

impl TryFrom<NonZero<usize>> for Alignment

type Error = TryFromSizeError

The type returned in the event of a conversion error.

fn try_from(len: NonZeroUsize) -> Result<Alignment, TryFromSizeError>

Performs the conversion.

impl TryFrom<usize> for Alignment

type Error = TryFromSizeError

The type returned in the event of a conversion error.

fn try_from(len: usize) -> Result<Alignment, TryFromSizeError>

Performs the conversion.

impl UpperHex for Alignment

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

Formats the value using the given formatter.

impl Copy for Alignment

impl Eq for Alignment

impl StructuralPartialEq for Alignment