Struct bit_struct::UnsafeStorage

#[repr(transparent)]
pub struct UnsafeStorage<T>(_);

UnsafeStorage is used to mark that there are some arbitrary invariants which must be maintained in storing its inner value. Therefore, creation and modifying of the inner value is an “unsafe” behavior. Although it might not be unsafe in traditional Rust terms (no memory unsafety), behavior might be “undefined”—or at least undocumented, because invariants are expected to be upheld.

This is useful in macros which do not encapsulate their storage in modules. This makes the macros for the end-user more ergonomic, as they can use the macro multiple times in a single module.

Implementations

impl<T> UnsafeStorage<T>

pub const unsafe fn new_unsafe(inner: T) -> Self

Create a new UnsafeStorage with the given inner value.

Safety

• See the broader scope that this is called in and which invariants are mentioned

pub unsafe fn as_ref_mut(&mut self) -> &mut T

Mutably access the value stored inside

Safety

This should be a safe operation assuming that when modifying T to T’, UnsafeStorage::new_unsafe(T’) is safe

impl<T: Copy> UnsafeStorage<T>

pub const fn inner(&self) -> T

Access the value stored inside

Trait Implementations

impl<T> AsRef<T> for UnsafeStorage<T>

fn as_ref(&self) -> &T

Access the value stored inside

impl<T: Clone> Clone for UnsafeStorage<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for UnsafeStorage<T>

fn default() -> UnsafeStorage<T>

Returns the “default value” for a type.

impl<T: Hash> Hash for UnsafeStorage<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,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for UnsafeStorage<T>

fn cmp(&self, other: &UnsafeStorage<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<UnsafeStorage<T>> for UnsafeStorage<T>

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

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

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

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

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

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

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

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

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

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<T: Copy> Copy for UnsafeStorage<T>

impl<T: Eq> Eq for UnsafeStorage<T>

impl<T> StructuralEq for UnsafeStorage<T>

impl<T> StructuralPartialEq for UnsafeStorage<T>