Struct core::ptr::Alignment

#[repr(transparent)]
pub struct Alignment(_);

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

A type storing a usize which is a power of two, and thus represents a possible alignment in the rust abstract machine.

Note that particularly large alignments, while representable in this type, are likely not to be supported by actual allocators and linkers.

Implementations

impl Alignment

pub const MIN: Self = _

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

The smallest possible alignment, 1.

All addresses are always aligned at least this much.

Examples

#![feature(ptr_alignment_type)]
use std::ptr::Alignment;

assert_eq!(Alignment::MIN.as_usize(), 1);

pub const fn of<T>() -> Self

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

Returns the alignment for a type.

This provides the same numerical value as mem::align_of, but in an Alignment instead of a `usize.

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

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

Creates an Alignment from a usize, or returns None if it’s not a power of two.

Note that 0 is not a power of two, nor a valid alignment.

pub unsafe fn new_unchecked(align: usize) -> Self

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

Creates an Alignment from a power-of-two usize.

Safety

align must be a power of two.

Equivalently, it must be 1 << exp for some exp in 0..usize::BITS. It must not be zero.

pub fn as_usize(self) -> usize

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

Returns the alignment as a NonZeroUsize

pub const fn as_nonzero(self) -> NonZeroUsize

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

Returns the alignment as a usize

pub fn log2(self) -> u32

🔬This is a nightly-only experimental API. (ptr_alignment_type #102070)

Returns the base-2 logarithm of the alignment.

This is always exact, as self represents a power of two.

Examples

#![feature(ptr_alignment_type)]
use std::ptr::Alignment;

assert_eq!(Alignment::of::<u8>().log2(), 0);
assert_eq!(Alignment::new(1024).unwrap().log2(), 10);

Trait Implementations

impl Clone for Alignment

fn clone(&self) -> Alignment

Returns a copy of the value.

const 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 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: Hasher>(data: &[Self], state: &mut H)where
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Alignment

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized,
    Self: PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Alignment> for Alignment

fn eq(&self, other: &Alignment) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Alignment> for Alignment

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<NonZeroUsize> for Alignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(align: NonZeroUsize) -> Result<Alignment, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Alignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(align: usize) -> Result<Alignment, Self::Error>

Performs the conversion.

impl Copy for Alignment

impl Eq for Alignment

impl StructuralEq for Alignment

impl StructuralPartialEq for Alignment