Struct Align

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

A size efficient, opaque representation of bytewise alignment.

See Alignment.h for LLVM’s corresponding structures.

Implementations

impl Align

pub const MAX_SHIFT: u8 = 63u8

The maximum alignment shift representable with this type.

pub const ALIGN8: Align

A convenience handle for types of exactly $width bits.

pub const ALIGN16: Align

A convenience handle for types of exactly $width bits.

pub const ALIGN32: Align

A convenience handle for types of exactly $width bits.

pub const ALIGN64: Align

A convenience handle for types of exactly $width bits.

pub const ALIGN128: Align

A convenience handle for types of exactly $width bits.

pub fn from_shift(shift: u8) -> Result<Align, AlignError>

Create an Align from the given shift value, returning an error if the requested shift is invalid.

pub fn from_byte_align(byte_align: u64) -> Result<Align, AlignError>

Create an Align from the given byte alignment value, returning an error if the requested shift is invalid.

pub fn from_bit_align(bit_align: u64) -> Result<Align, AlignError>

Create an Align from the given bit alignment value, returning an error if the requested shift is invalid.

pub fn shift(&self) -> u8

Return this alignment’s shift value, i.e. the power of two for the alignment.

pub fn byte_align(&self) -> u64

Return this alignment as a byte-granular alignment.

pub fn bit_align(&self) -> u64

Return this alignment as a bit-granular alignment.

Trait Implementations

impl Clone for Align

fn clone(&self) -> Align

Returns a duplicate 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<(), FmtError>

Formats the value using the given formatter.

impl Display for Align

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

Formats the value using the given formatter.

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