Struct AlignedZst

pub struct AlignedZst<const ALIGNMENT: usize>
where
    Alignment<ALIGNMENT>: SupportedAlignment,
{ /* private fields */ }

A Zero-sized type with the specified alignment.

To facilitate deriving traits on types containing this type, this type implements most relevant traits, including Default, Ord, Copy, Send, Sync, Unpin, etc.

With the bytemuck optional feature enabled, this type implements the bytemuck::Pod trait.

With the freeze optional feature enabled, this type implements the unstable core::marker::Freeze trait.

Implementations

impl<const ALIGNMENT: usize> AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

pub const fn new() -> Self

Creates a new AlignedZst.

This does the same thing as <Self as Default>::default(), but is usable in const.

Trait Implementations

impl<const ALIGNMENT: usize> Clone for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

fn clone(&self) -> AlignedZst<ALIGNMENT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const ALIGNMENT: usize> Debug for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

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

Formats the value using the given formatter.

impl<const ALIGNMENT: usize> Default for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

fn default() -> AlignedZst<ALIGNMENT>

Returns the “default value” for a type.

impl<const ALIGNMENT: usize> Hash for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

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<const ALIGNMENT: usize> Ord for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

fn cmp(&self, other: &AlignedZst<ALIGNMENT>) -> 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<const ALIGNMENT: usize> PartialEq for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

fn eq(&self, other: &AlignedZst<ALIGNMENT>) -> 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<const ALIGNMENT: usize> PartialOrd for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

fn partial_cmp(&self, other: &AlignedZst<ALIGNMENT>) -> 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<const ALIGNMENT: usize> Zeroable for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

Available on crate feature bytemuck only.

fn zeroed() -> Self

Calls zeroed.

impl<const ALIGNMENT: usize> Copy for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

impl<const ALIGNMENT: usize> Eq for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

impl<const ALIGNMENT: usize> Pod for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,

Available on crate feature bytemuck only.

impl<const ALIGNMENT: usize> StructuralPartialEq for AlignedZst<ALIGNMENT>

where Alignment<ALIGNMENT>: SupportedAlignment,