Struct Alignment

Source
pub struct Alignment(/* private fields */);
Expand description

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

Implementations§

Source§

impl Alignment

Source

pub const MIN: Alignment

Minimum alignment.

Source

pub const MAX: Alignment

Maximum alignment.

Source

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

Converts a usize into an Alignment.

Source

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.

Source

pub const fn as_usize(self) -> usize

Converts to a usize.

Source

pub const fn as_nonzero(self) -> NonZeroUsize

Converts to a NonZeroUsize.

Source

pub const fn as_len(self) -> DoubledLen

Converts to a DoubledLen.

Source

pub const fn log2(self) -> u32

Returns the base-2 logarithm of the alignment.

This is always exact.

Source

pub const fn mask(self) -> usize

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

Trait Implementations§

Source§

impl Binary for Alignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Clone for Alignment

Source§

fn clone(&self) -> Alignment

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
Source§

impl Debug for Alignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Alignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Alignment> for DoubledLen

Source§

fn from(align: Alignment) -> DoubledLen

Converts to this type from the input type.
Source§

impl From<Alignment> for NonZeroUsize

Source§

fn from(align: Alignment) -> NonZeroUsize

Converts to this type from the input type.
Source§

impl From<Alignment> for usize

Source§

fn from(align: Alignment) -> usize

Converts to this type from the input type.
Source§

impl Hash for Alignment

Source§

fn hash<__H: Hasher>(&self, state: &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
Source§

impl LowerHex for Alignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Octal for Alignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Ord for Alignment

Source§

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

impl PartialEq for Alignment

Source§

fn eq(&self, other: &Alignment) -> 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.
Source§

impl PartialOrd for Alignment

Source§

fn partial_cmp(&self, other: &Alignment) -> 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
Source§

impl TryFrom<DoubledLen> for Alignment

Source§

type Error = ZeroLenError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<NonZero<usize>> for Alignment

Source§

type Error = TryFromSizeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<usize> for Alignment

Source§

type Error = TryFromSizeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl UpperHex for Alignment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for Alignment

Source§

impl Eq for Alignment

Source§

impl StructuralPartialEq for Alignment

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.