Enum ref_kind::RefKind

pub enum RefKind<'a, T>where
    T: ?Sized + 'a,{
    Ref(&'a T),
    Mut(&'a mut T),
}

Provides different kinds of reference: immutable or mutable one.

Variants

Ref(&'a T)

Immutable kind of reference.

Mut(&'a mut T)

Mutable kind of reference.

Implementations

impl<'a, T> RefKind<'a, T>where T: ?Sized + 'a,

pub fn is_ref(&self) -> bool

Checks if RefKind contains immutable reference.

pub fn is_mut(&self) -> bool

Checks if RefKind contains mutable reference.

pub fn get_ref(&self) -> &T

Returns an immutable reference from the RefKind.

pub fn get_mut(&mut self) -> Option<&mut T>

Returns Some with a mutable reference from the struct or None if contained reference is immutable.

pub fn into_ref(self) -> &'a T

Converts RefKind into immutable reference with the lifetime of the owner, consuming the self value.

pub fn into_mut(self) -> Option<&'a mut T>

Returns Some with a mutable reference with the lifetime of the owner or None if contained reference is immutable, consuming the self value.

pub fn unwrap_ref(self) -> &'a T

Returns the contained Ref value, consuming the self value.

Panics

Panics if the value is a Mut.

pub fn unwrap_mut(self) -> &'a mut T

Returns the contained Mut value, consuming the self value.

Panics

Panics if the value is a Ref.

Trait Implementations

impl<'a, T, R> AsRef<R> for RefKind<'a, T>where T: ?Sized + 'a, R: ?Sized, <RefKind<'a, T> as Deref>::Target: AsRef<R>,

As suggested in this standard library section.

fn as_ref(&self) -> &R

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, T> Debug for RefKind<'a, T>where T: ?Sized + 'a + Debug,

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

Formats the value using the given formatter.

impl<'a, T> Deref for RefKind<'a, T>where T: ?Sized + 'a,

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T> From<&'a T> for RefKind<'a, T>where T: ?Sized + 'a,

Convert immutable reference into RefKind.

fn from(shared: &'a T) -> Self

Converts to Ref from the immutable reference.

impl<'a, T> From<&'a mut T> for RefKind<'a, T>where T: ?Sized + 'a,

Convert mutable reference into RefKind.

fn from(unique: &'a mut T) -> Self

Converts to Mut from the mutable reference.

impl<'a, T> Hash for RefKind<'a, T>where T: ?Sized + 'a + Hash,

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<'a, T> Ord for RefKind<'a, T>where T: ?Sized + 'a + Ord,

fn cmp(&self, other: &RefKind<'a, T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'a, T> PartialEq<RefKind<'a, T>> for RefKind<'a, T>where T: ?Sized + 'a + PartialEq,

fn eq(&self, other: &RefKind<'a, 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<'a, T> PartialOrd<RefKind<'a, T>> for RefKind<'a, T>where T: ?Sized + 'a + PartialOrd,

fn partial_cmp(&self, other: &RefKind<'a, 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<'a, T> Eq for RefKind<'a, T>where T: ?Sized + 'a + Eq,

impl<'a, T> StructuralEq for RefKind<'a, T>where T: ?Sized + 'a,

impl<'a, T> StructuralPartialEq for RefKind<'a, T>where T: ?Sized + 'a,