Enum rscontainer::Poisoning

pub enum Poisoning<S> {
    Healthy(S),
    Poisoned(S),
}

Indicates whether an instance is poisoned or not.

More information about poisoning in the Nomicon.

How to use this:

• For pointer types that don’t support poisoning, use assert_healthy.
• When it’s a hard bug if the value is poisoned, use assert_healthy.
• When poisoning status doesn’t matter, use unpoison.
• When you need different logic for poisoned or not, use a match statement.

Variants

Healthy(S)

The instance is not poisoned, program flow can continue as usual.

Poisoned(S)

The instance is poisoned, extra care should be taken when handling the value.

Implementations

impl<S> Poisoning<S>

pub fn assert_healthy(self) -> S

Returns the instance if it is not poisoned, panics if it is poisoned.

pub fn assert_poisoned(self) -> S

Returns the instance if it is poisoned, panics if it is not poisoned.

pub fn unpoison(self) -> S

Always returns the instance, whether it’s poisoned or not.

For pointer types that don’t support poisoning, prefer assert_healthy, as this won’t introduce hidden bugs when the pointer type is changed at a later time.

Only use this if you’re certain that it doesn’t matter if the value is poisoned.

pub const fn is_healthy(&self) -> bool

Returns true if the instance is Healthy.

pub const fn is_poisoned(&self) -> bool

Returns true if the instance is Poisoned.

pub const fn as_healthy(&self) -> Option<&S>

Returns Some(&S) if the value is not poisoned, returns None if it is poisoned.

pub const fn as_poisoned(&self) -> Option<&S>

Returns Some(&S) if the value is poisoned, returns None if it is not poisoned.

pub fn as_healthy_mut(&mut self) -> Option<&mut S>

Returns Some(&mut S) if the value is not poisoned, returns None if it is poisoned.

pub fn as_poisoned_mut(&mut self) -> Option<&mut S>

Returns Some(&mut S) if the value is poisoned, returns None if it is not poisoned.

pub fn into_healthy(self) -> Option<S>

Converts the value into Some(S) if it is not poisoned. Converterts the value into None if it is poisoned.

pub fn into_poisoned(self) -> Option<S>

Converts the value into Some(S) if it is poisoned. Converterts the value into None if it is not poisoned.

Trait Implementations

impl<S: Clone> Clone for Poisoning<S>

fn clone(&self) -> Poisoning<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Poisoning<S>

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

Formats the value using the given formatter.

impl<S: Hash> Hash for Poisoning<S>

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<S: Ord> Ord for Poisoning<S>

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

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq<Poisoning<S>> for Poisoning<S>

fn eq(&self, other: &Poisoning<S>) -> bool

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

fn ne(&self, other: &Poisoning<S>) -> bool

This method tests for !=.

impl<S: PartialOrd> PartialOrd<Poisoning<S>> for Poisoning<S>

fn partial_cmp(&self, other: &Poisoning<S>) -> 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<S: Copy> Copy for Poisoning<S>

impl<S: Eq> Eq for Poisoning<S>

impl<S> StructuralEq for Poisoning<S>

impl<S> StructuralPartialEq for Poisoning<S>