Struct inert::Inert

#[repr(transparent)]
pub struct Inert<T: ?Sized> { /* fields omitted */ }

A wrapper for neutralized values.

If T is Neutralize, then it can be safely neutralized from an immutable reference. Almost everything implements Neutralize but RefCell<T> (and similar types).

If T is NeutralizeMut, then it can be safely neutralized from a mutable reference. Almost everything implements NeutralizeMut but Rc<RefCell<T>> and &'a RefCell<T> (and similar types).

If T is NeutralizeUnsafe, this type derefs to T::Output, with no safe way to reach out for the T value itself, which is why it is sound for Inert<T> to be Sync.

Methods

impl<T> Inert<T> where
    T: ?Sized, 

pub fn new(value: &T) -> &Self where
    T: Neutralize, 

Creates a new Inert<T> from a reference.

pub fn new_mut(value: &mut T) -> &Self where
    T: NeutralizeMut, 

Creates a new Inert<T> from a mutable reference.

pub unsafe fn new_unchecked(value: &T) -> &Self

Unsafely creates a new Inert<T> from a reference.

Safety

The user must swear on the holy baguette that they won't do anything with the &T as long as any thread is still doing things with the &Inert<T>, either directly or through other neutralized values reached through the inner &T::Output value, lest they provoke undefined behaviour, or worse, spoil their entire wheat harvest.

pub fn get_ref(this: &Self) -> &T where
    T: Sync, 

Returns a reference to the inner T.

pub unsafe fn get_ref_unchecked(this: &Self) -> &T

Unsafely returns a reference to the inner T.

Safety

Undefined behaviour is possible if T is not Sync.

Trait Implementations

impl<T: ?Sized> PartialOrd<Inert<T>> for Inert<T> where
    T: NeutralizeUnsafe,
    T::Output: PartialOrd, 

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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: ?Sized> AsRef<<T as NeutralizeUnsafe>::Output> for Inert<T> where
    T: NeutralizeUnsafe, 

fn as_ref(&self) -> &T::Output

Performs the conversion.

impl<T: ?Sized> PartialEq<Inert<T>> for Inert<T> where
    T: NeutralizeUnsafe,
    T::Output: PartialEq, 

fn eq(&self, other: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T> Sync for Inert<T> where
    T: ?Sized, 

impl<T: ?Sized> Ord for Inert<T> where
    T: NeutralizeUnsafe,
    T::Output: Ord, 

fn cmp(&self, other: &Self) -> 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.

impl<T: ?Sized> Eq for Inert<T> where
    T: NeutralizeUnsafe,
    T::Output: Eq, 

impl<T: ?Sized> Display for Inert<T> where
    T: NeutralizeUnsafe,
    T::Output: Display, 

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

Formats the value using the given formatter.

impl<T: ?Sized> Debug for Inert<T> where
    T: NeutralizeUnsafe,
    T::Output: Debug, 

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Inert<T> where
    T: NeutralizeUnsafe, 

type Target = T::Output

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.