Enum into_owned::Is

pub enum Is<'a, T> where
    T: Owned,  {
    Owned(T),
    Borrowed(&'a T),
    MutBorrowed(&'a mut T),
}

Represents an owned value, an immutably borrowed reference, or a mutably borrowed reference.

Is<'a, T> is similar to Cow<'a, B>. Unlike Cow<'a, B>, it can hold a mutably borrowed reference. This enum can be created by the as_is method on IntoOwned.

This enum, as a clone-on-write smart pointer, is highly experimental. Most parts are subject to change. Especially, more traits (e.g. from core::ops) will be implemented.

Variants

Owned(T)

Borrowed(&'a T)

MutBorrowed(&'a mut T)

Implementations

impl<'_, T> Is<'_, T> where
    T: Owned, 

pub fn to_mut(&mut self) -> &mut T where
    T: Clone, 

Trait Implementations

impl<'_, T, U> AsRef<U> for Is<'_, T> where
    T: Owned + AsRef<U>,
    U: ?Sized, 

fn as_ref(&self) -> &U

Performs the conversion.

impl<'_, T> Binary for Is<'_, T> where
    T: Owned + Binary, 

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

Formats the value using the given formatter.

impl<'_, T> Borrow<T> for Is<'_, T> where
    T: Owned, 

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'_, T> Clone for Is<'_, T> where
    T: Owned + Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Is<'a, T> where
    T: Owned, 

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

Formats the value using the given formatter.

impl<'_, T> Default for Is<'_, T> where
    T: Owned + Default, 

fn default() -> Self

Creates an owned Is<'a, T> with the default value of T.

impl<'_, T> Deref for Is<'_, T> where
    T: Owned, 

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'_, T> Display for Is<'_, T> where
    T: Owned + Display, 

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

Formats the value using the given formatter.

impl<'_, T> Eq for Is<'_, T> where
    T: Owned + Eq, 

impl<'_, T> Hash for Is<'_, T> where
    T: Owned + 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<'_, T> IntoOwned for Is<'_, T> where
    T: Owned, 

type Owned = T

The owned type associated with Self.

fn as_is<'a>(self) -> Is<'a, Self::Owned> where
    Self: 'a, 

Returns self as [Is<'a, T>] (T is Self::Owned here).

fn into_owned(self) -> Self::Owned where
    Self::Owned: Clone, 

Converts self into an owned value.

fn into_gyu<'a>(self) -> Gyu<'a, Self::Owned> where
    Self: 'a, 

Converts self into [Gyu<'a, T>] (T is Self::Owned here).

fn try_into_gyu_mut<'a>(self) -> Option<GyuMut<'a, Self::Owned>> where
    Self: 'a, 

Converts self into [GyuMut<'a, T>] (T is Self::Owned here) if possible, i.e., self is not an immutably borrowed reference. If [GyuMut<'a, T>] is necessary, use [to_gyu_mut] method instead.

fn to_gyu_mut<'a>(self) -> GyuMut<'a, Self::Owned> where
    Self: 'a,
    Self::Owned: Clone, 

Converts self into [GyuMut<'a, T>] (T is Self::Owned here). Unlike [try_into_gyu_mut] method, it clones self if it is an immutably borrowed reference.

fn into_cow<'a, B: ?Sized>(self) -> Cow<'a, B> where
    Self: 'a,
    Self::Owned: Borrow<B>,
    B: ToOwned<Owned = Self::Owned>, 

Converts self into [Cow<'a, B>].

impl<'_, T> LowerExp for Is<'_, T> where
    T: Owned + LowerExp, 

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

Formats the value using the given formatter.

impl<'_, T> LowerHex for Is<'_, T> where
    T: Owned + LowerHex, 

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

Formats the value using the given formatter.

impl<'_, T> Octal for Is<'_, T> where
    T: Owned + Octal, 

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

Formats the value using the given formatter.

impl<'_, T> Ord for Is<'_, T> where
    T: Owned + Ord, 

fn cmp(&self, other: &Self) -> 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, U> PartialEq<Is<'_, U>> for Is<'_, T> where
    T: Owned + PartialEq<U>,
    U: Owned, 

fn eq(&self, other: &Is<U>) -> 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, U> PartialOrd<Is<'_, U>> for Is<'_, T> where
    T: Owned + PartialOrd<U>,
    U: Owned, 

fn partial_cmp(&self, other: &Is<U>) -> 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> UpperExp for Is<'_, T> where
    T: Owned + UpperExp, 

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

Formats the value using the given formatter.

impl<'_, T> UpperHex for Is<'_, T> where
    T: Owned + UpperHex, 

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

Formats the value using the given formatter.