Struct BitElement 

#[repr(transparent)]
#[doc(hidden)] pub struct BitElement<T = usize> {
    pub elem: T,
}

Unified Element Constructor

This type is a hack around the fact that Cell and AtomicUN all have const fn new(val: Inner) -> Self; constructors, but the numberic fundamentals do not. As such, the standard library does not provide a unified construction syntax to turn an integer fundamental into the final type.

This provides a const fn BitElement::<_>::new(R) -> Self; function, implemented only for the BitStore implementors that the crate provides, that the constructor macros can use to turn integers into final values without using mem::transmute. While transmute is acceptable in this case (the types are all #[repr(transparent)]), it is still better avoided where possible.

As this is a macro assistant, it is publicly exposed, but is not public API. It has no purpose outside of the crate’s macros.

Fields

elem: T

Implementations

impl BitElement<u8>

pub const fn new(elem: u8) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<Cell<u8>>

pub const fn new(elem: u8) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<AtomicU8>

pub const fn new(elem: u8) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<u16>

pub const fn new(elem: u16) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<Cell<u16>>

pub const fn new(elem: u16) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<AtomicU16>

pub const fn new(elem: u16) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<u32>

pub const fn new(elem: u32) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<Cell<u32>>

pub const fn new(elem: u32) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<AtomicU32>

pub const fn new(elem: u32) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<u64>

pub const fn new(elem: u64) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<Cell<u64>>

pub const fn new(elem: u64) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<AtomicU64>

pub const fn new(elem: u64) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<usize>

pub const fn new(elem: usize) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<Cell<usize>>

pub const fn new(elem: usize) -> Self

Creates a new element wrapper from a raw integer.

impl BitElement<AtomicUsize>

pub const fn new(elem: usize) -> Self

Creates a new element wrapper from a raw integer.

Trait Implementations

impl<T: Clone> Clone for BitElement<T>

fn clone(&self) -> BitElement<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BitElement<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for BitElement<T>

fn default() -> BitElement<T>

Returns the “default value” for a type.

impl<T: Eq> Eq for BitElement<T>

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

impl<T: Hash> Hash for BitElement<T>

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<T: Ord> Ord for BitElement<T>

fn cmp(&self, other: &BitElement<T>) -> 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<T: PartialEq> PartialEq for BitElement<T>

fn eq(&self, other: &BitElement<T>) -> 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<T: PartialOrd> PartialOrd for BitElement<T>

fn partial_cmp(&self, other: &BitElement<T>) -> 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.

#[doc(hidden)] fn __chaining_lt(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

If self == other, returns ControlFlow::Continue(()). Otherwise, returns ControlFlow::Break(self < other).

#[doc(hidden)] fn __chaining_le(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for <= instead of <.

#[doc(hidden)] fn __chaining_gt(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for > instead of <.

#[doc(hidden)] fn __chaining_ge(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for >= instead of <.

impl<T: Copy> Copy for BitElement<T>

impl<T> StructuralPartialEq for BitElement<T>