Struct ffi_std::Frozen

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

Utility struct to "freeze" a T. Immutable access is allowed but mutable access is not.

Methods

impl<T> Frozen<T>

pub const fn new(x: T) -> Self

Wrap a value, making it immutable.

pub unsafe fn into_inner(self) -> T

Bypasses immutability and gets the inner T. Don't do this please.

pub const unsafe fn get_mut(&mut self) -> &mut T

Bypasses immutability and gets a mutable reference. Don't do this please.

Trait Implementations

impl<T: Clone> Clone for Frozen<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Frozen<T>

impl<T: Debug> Debug for Frozen<T>

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

Formats the value using the given formatter.

impl<T> Deref for Frozen<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Display> Display for Frozen<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Frozen<T>

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

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Frozen<T>> for Frozen<T>

fn eq(&self, other: &Frozen<T>) -> bool

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

fn ne(&self, other: &Frozen<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Frozen<T>> for Frozen<T>

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

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

fn lt(&self, other: &Frozen<T>) -> bool

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

fn le(&self, other: &Frozen<T>) -> bool

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

fn gt(&self, other: &Frozen<T>) -> bool

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

fn ge(&self, other: &Frozen<T>) -> bool

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

impl<T> StructuralEq for Frozen<T>

impl<T> StructuralPartialEq for Frozen<T>