Struct Align

pub struct Align { /* private fields */ }

Alignment of a type in bytes (always a power of two).

Implementations

impl Align

pub const ONE: Align = _

pub const EIGHT: Align = _

pub const MAX: Align = _

pub fn from_bits(bits: u64) -> Result<Align, AlignFromBytesError>

pub const fn from_bytes(align: u64) -> Result<Align, AlignFromBytesError>

pub fn bytes(self) -> u64

pub fn bytes_usize(self) -> usize

pub fn bits(self) -> u64

pub fn bits_usize(self) -> usize

pub fn max_for_offset(offset: Size) -> Align

Computes the best alignment possible for the given offset (the largest power of two that the offset is a multiple of).

N.B., for an offset of 0, this happens to return 2^64.

pub fn restrict_for_offset(self, offset: Size) -> Align

Lower the alignment, if necessary, such that the given offset is aligned to it (the offset is a multiple of the alignment).

Trait Implementations

impl Clone for Align

fn clone(&self) -> Align

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Align

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

Formats the value using the given formatter.

impl Hash for Align

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 Align

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

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

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

impl Eq for Align

impl StructuralPartialEq for Align