Struct TypeAlignSpec

#[non_exhaustive]
pub struct TypeAlignSpec {
    pub aligned_type: AlignedType,
    pub abi_alignment: Align,
    pub preferred_alignment: Align,
}

Represents an alignable type, along with its ABI-mandated and preferred alignments (which may differ).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

aligned_type: AlignedType

The type being aligned.

abi_alignment: Align

The ABI-enforced alignment for the type.

preferred_alignment: Align

The preferred alignment for the type.

NOTE: This must be greater than or equal to the ABI alignment. This invariant is preserved during construction.

Implementations

impl TypeAlignSpec

pub const MAX_TYPE_BIT_WIDTH: u32 = 8_388_607u32

The maximum type width, in bits, representable in this structure.

pub const MAX_ALIGN: Align

The maximum alignment supported by instances of TypeAlignSpec.

pub fn new( aligned_type: AlignedType, abi: Align, pref: Align, ) -> Result<Self, AlignSpecError>

Create a new TypeAlignSpec for the given AlignedType and alignment constraints.

Trait Implementations

impl Clone for TypeAlignSpec

fn clone(&self) -> TypeAlignSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeAlignSpec

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

Formats the value using the given formatter.

impl FromStr for TypeAlignSpec

type Err = AlignSpecError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for TypeAlignSpec

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

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

fn partial_cmp(&self, other: &Self) -> 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 TypeAlignSpec

impl Eq for TypeAlignSpec