Struct std::ptr::Alignment
pub struct Alignment(/* private fields */);🔬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 Alignmentpub const MIN: Alignment = _🔬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>() -> Alignment🔬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<Alignment>🔬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) -> Alignment🔬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 usize
pub const fn as_nonzero(self) -> NonZeroUsize🔬This is a nightly-only experimental API. (
ptr_alignment_type #102070)
Returns the alignment as a NonZeroUsize
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 Alignmentfn clone(&self) -> Alignment
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read more
impl Debug for Alignmentfn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl From<Alignment> for NonZeroUsizefn from(align: Alignment) -> NonZeroUsize
Converts to this type from the input type.
impl From<Alignment> for usizefn from(align: Alignment) -> usize
Converts to this type from the input type.
impl Hash for Alignmentfn hash<H>(&self, state: &mut H)
where
H: Hasher,fn hash_slice<H>(data: &[Self], state: &mut H)
where
H: Hasher,
Self: Sized,impl Ord for Alignmentfn cmp(&self, other: &Alignment) -> Orderingfn max(self, other: Self) -> Self
where
Self: Sized,
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
where
Self: Sized,
Compares and returns the minimum of two values. Read more
fn clamp(self, min: Self, max: Self) -> Self
where
Self: Sized + PartialOrd,
Restrict a value to a certain interval. Read more
impl PartialEq for Alignmentfn eq(&self, other: &Alignment) -> bool
This method tests for
self and other values to be equal, and is used by ==.
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 for Alignmentfn partial_cmp(&self, other: &Alignment) -> Option<Ordering>fn lt(&self, other: &Rhs) -> boolfn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self and other) and is used by the <= operator. Read more
fn gt(&self, other: &Rhs) -> boolfn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for
self and other) and is used by the >= operator. Read more
impl TryFrom<NonZeroUsize> for Alignmenttype Error = TryFromIntError
The type returned in the event of a conversion error.
fn try_from(
align: NonZeroUsize
) -> Result<Alignment, <Alignment as TryFrom<NonZeroUsize>>::Error>
Performs the conversion.
impl TryFrom<usize> for Alignmenttype Error = TryFromIntError
The type returned in the event of a conversion error.
fn try_from(
align: usize
) -> Result<Alignment, <Alignment as TryFrom<usize>>::Error>
Performs the conversion.
impl Copy for Alignmentimpl Eq for Alignmentimpl StructuralEq for Alignmentimpl StructuralPartialEq for AlignmentAuto Trait Implementations
impl RefUnwindSafe for Alignmentimpl Send for Alignmentimpl Sync for Alignmentimpl Unpin for Alignmentimpl UnwindSafe for AlignmentBlanket Implementations
impl<T> Any for T
where
T: 'static + ?Sized,impl<T> Borrow<T> for T
where
T: ?Sized,impl<T> BorrowMut<T> for T
where
T: ?Sized,impl<T> From<T> for Tfn from(t: T) -> TReturns the argument unchanged.
impl<T, U> Into<U> for T
where
U: From<T>,fn into(self) -> UCalls U::from(self).
That is, this conversion is whatever the implementation of From<T> for U chooses to do.
impl<T> ToOwned for T
where
T: Clone,type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T, U> TryFrom<U> for T
where
U: Into<T>,type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
impl<T, U> TryInto<U> for T
where
U: TryFrom<T>,type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ptr/struct.Alignment.html