Enum boow::Bow

pub enum Bow<'a, T: 'a> {
    Owned(T),
    Borrowed(&'a T),
}

Borrow-Or-oWned smart pointer.

[Bow] implements [Deref], which means that you can call non-mutating methods directly on the data it encloses. If mutation is desired, borrow_mut will obtain some mutable reference to an owned value, but only if it is owned.

Variants

Owned(T)Borrowed(&'a T)

Methods

impl<'a, T: 'a> Bow<'a, T>

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

Get a mutable reference to the enclosed value. Return [None] if the value is not owned.

pub fn extract(self) -> Option<T>

Consume the enclosed value and return it if it is owned.

Trait Implementations

impl<'a, T: Copy + 'a> Copy for Bow<'a, T>

impl<'a, T: Clone + 'a> Clone for Bow<'a, T>

fn clone(&self) -> Bow<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: 'a> Borrow<T> for Bow<'a, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T: 'a> Deref for Bow<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: 'a> Eq for Bow<'a, T> where
    T: Eq, 

impl<'a, T: 'a> Ord for Bow<'a, T> where
    T: Ord, 

fn cmp(&self, other: &Bow<'a, 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.

impl<'a, T: 'a> PartialEq for Bow<'a, T> where
    T: PartialEq, 

fn eq(&self, other: &Bow<'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 !=.

impl<'a, T: 'a> PartialOrd for Bow<'a, T> where
    T: PartialOrd, 

fn partial_cmp(&self, other: &Bow<'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: 'a> Debug for Bow<'a, T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<'a, T: 'a> Display for Bow<'a, T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<'a, T: 'a> Default for Bow<'a, T> where
    T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<'a, T: 'a> Hash for Bow<'a, T> where
    T: 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, 

Feeds a slice of this type into the given [Hasher].

impl<'a, T: 'a> AsRef<T> for Bow<'a, T>

fn as_ref(&self) -> &T

Performs the conversion.