Enum as_is::Is

pub enum Is<'a, T: ?Sized + ToOwned> {
    Owned(T::Owned),
    Borrowed(&'a T),
    MutBorrowed(&'a mut T),
}

Represents an owned, immutably borrowed, or mutably borrowed data.

Variants

Owned(T::Owned)

Owned data.

Borrowed(&'a T)

Immutably borrowed data.

MutBorrowed(&'a mut T)

Mutably borrowed data.

Trait Implementations

impl<T: ?Sized + ToOwned, U: AsIs, O> Add<U> for Is<'_, T>where
    for<'a> T::Owned: Add<Owned<U>, Output = O> + Add<&'a Owned<U>, Output = O> + Add<&'a U::Is, Output = O>,
    for<'a> T: RefAdd<Owned<U>, Output = O> + RefAdd<&'a Owned<U>, Output = O> + RefAdd<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the + operator.

fn add(self, rhs: U) -> Self::Output

Performs the + operation.

impl<T: ?Sized + ToOwned> AsIs for Is<'_, T>

type Is = T

The base type associated with both owned and borrowed data.

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

Converts self into an Is<'a, Self::Is>.

fn borrow_or_clone<B: ?Sized>(&self) -> IsCow<'_, B>where
    T: Borrow<B>,
    T::Owned: Borrow<B>,
    B: ToOwned<Owned = T::Owned>,

Immutably borrows from self by default, but can be overridden to clone self if appropriate.

fn into_is<'a, B: ?Sized>(self) -> Is<'a, B>where
    Self: 'a,
    Self::Is: BorrowMut<B>,
    B: ToOwned<Owned = Owned<Self>>,

Converts self into an Is<'a, B>.

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

Converts self into an IsCow<'a, B>.

fn try_into_is_mut<'a, B: ?Sized>(
    self
) -> Result<IsMut<'a, B>, Is<'a, Self::Is>>where
    Self: 'a,
    Self::Is: BorrowMut<B>,
    B: ToOwned<Owned = Owned<Self>>,

Converts self into an IsMut<'a, B> without cloning if possible.

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

Converts self into an owned data without cloning if possible.

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

Converts self into a Cow<'a, B>. Only available if the alloc feature is enabled.

impl<T: ?Sized + ToOwned, U: AsIs, O> BitAnd<U> for Is<'_, T>where
    for<'a> T::Owned: BitAnd<Owned<U>, Output = O> + BitAnd<&'a Owned<U>, Output = O> + BitAnd<&'a U::Is, Output = O>,
    for<'a> T: RefBitAnd<Owned<U>, Output = O> + RefBitAnd<&'a Owned<U>, Output = O> + RefBitAnd<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the & operator.

fn bitand(self, rhs: U) -> Self::Output

Performs the & operation.

impl<T: ?Sized + ToOwned, U: AsIs, O> BitOr<U> for Is<'_, T>where
    for<'a> T::Owned: BitOr<Owned<U>, Output = O> + BitOr<&'a Owned<U>, Output = O> + BitOr<&'a U::Is, Output = O>,
    for<'a> T: RefBitOr<Owned<U>, Output = O> + RefBitOr<&'a Owned<U>, Output = O> + RefBitOr<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the | operator.

fn bitor(self, rhs: U) -> Self::Output

Performs the | operation.

impl<T: ?Sized + ToOwned, U: AsIs, O> BitXor<U> for Is<'_, T>where
    for<'a> T::Owned: BitXor<Owned<U>, Output = O> + BitXor<&'a Owned<U>, Output = O> + BitXor<&'a U::Is, Output = O>,
    for<'a> T: RefBitXor<Owned<U>, Output = O> + RefBitXor<&'a Owned<U>, Output = O> + RefBitXor<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: U) -> Self::Output

Performs the ^ operation.

impl<T: ?Sized + ToOwned> Borrow<T> for Is<'_, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T: Debug + ?Sized + ToOwned> Debug for Is<'a, T>where
    T::Owned: Debug,

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

Formats the value using the given formatter.

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

fn default() -> Self

Creates an owned Is<'_, T> with the default value for T::Owned.

impl<T: ?Sized + ToOwned> Deref for Is<'_, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized + ToOwned, U: AsIs, O> Div<U> for Is<'_, T>where
    for<'a> T::Owned: Div<Owned<U>, Output = O> + Div<&'a Owned<U>, Output = O> + Div<&'a U::Is, Output = O>,
    for<'a> T: RefDiv<Owned<U>, Output = O> + RefDiv<&'a Owned<U>, Output = O> + RefDiv<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the / operator.

fn div(self, rhs: U) -> Self::Output

Performs the / operation.

impl<T: ?Sized + ToOwned> Hash for Is<'_, 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<T: ?Sized + ToOwned, U: AsIs, O> Mul<U> for Is<'_, T>where
    for<'a> T::Owned: Mul<Owned<U>, Output = O> + Mul<&'a Owned<U>, Output = O> + Mul<&'a U::Is, Output = O>,
    for<'a> T: RefMul<Owned<U>, Output = O> + RefMul<&'a Owned<U>, Output = O> + RefMul<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the * operator.

fn mul(self, rhs: U) -> Self::Output

Performs the * operation.

impl<T: ?Sized + ToOwned, O> Neg for Is<'_, T>where
    T::Owned: Neg<Output = O>,
    T: RefNeg<Output = O>,

type Output = O

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: ?Sized + ToOwned, O> Not for Is<'_, T>where
    T::Owned: Not<Output = O>,
    T: RefNot<Output = O>,

type Output = O

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: ?Sized + ToOwned> Ord for Is<'_, T>where
    T: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: ?Sized + ToOwned, U: ?Sized + ToOwned> PartialEq<Is<'_, U>> for Is<'_, T>where
    T: PartialEq<U>,

fn eq(&self, other: &Is<'_, U>) -> bool

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

const 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<T: ?Sized + ToOwned, U: ?Sized + ToOwned> PartialEq<Is<'_, U>> for IsCow<'_, T>where
    T: PartialEq<U>,

fn eq(&self, other: &Is<'_, U>) -> bool

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

const 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<T: ?Sized + ToOwned, U: ?Sized + ToOwned> PartialEq<Is<'_, U>> for IsMut<'_, T>where
    T: PartialEq<U>,

fn eq(&self, other: &Is<'_, U>) -> bool

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

const 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<T: ?Sized + ToOwned, U: ?Sized + ToOwned> PartialEq<IsCow<'_, U>> for Is<'_, T>where
    T: PartialEq<U>,

fn eq(&self, other: &IsCow<'_, U>) -> bool

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

const 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<T: ?Sized + ToOwned, U: ?Sized + ToOwned> PartialEq<IsMut<'_, U>> for Is<'_, T>where
    T: PartialEq<U>,

fn eq(&self, other: &IsMut<'_, U>) -> bool

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

const 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<T: ?Sized + ToOwned, U: ?Sized + ToOwned> PartialOrd<Is<'_, U>> for Is<'_, T>where
    T: PartialOrd<U>,

fn partial_cmp(&self, other: &Is<'_, U>) -> Option<Ordering>

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

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

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

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

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

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

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

const 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 + ToOwned, U: ?Sized + ToOwned> PartialOrd<Is<'_, U>> for IsCow<'_, T>where
    T: PartialOrd<U>,

fn partial_cmp(&self, other: &Is<'_, U>) -> Option<Ordering>

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

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

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

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

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

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

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

const 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 + ToOwned, U: ?Sized + ToOwned> PartialOrd<Is<'_, U>> for IsMut<'_, T>where
    T: PartialOrd<U>,

fn partial_cmp(&self, other: &Is<'_, U>) -> Option<Ordering>

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

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

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

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

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

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

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

const 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 + ToOwned, U: ?Sized + ToOwned> PartialOrd<IsCow<'_, U>> for Is<'_, T>where
    T: PartialOrd<U>,

fn partial_cmp(&self, other: &IsCow<'_, U>) -> Option<Ordering>

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

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

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

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

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

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

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

const 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 + ToOwned, U: ?Sized + ToOwned> PartialOrd<IsMut<'_, U>> for Is<'_, T>where
    T: PartialOrd<U>,

fn partial_cmp(&self, other: &IsMut<'_, U>) -> Option<Ordering>

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

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

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

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

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

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

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

const 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 + ToOwned, U: AsIs, O> Rem<U> for Is<'_, T>where
    for<'a> T::Owned: Rem<Owned<U>, Output = O> + Rem<&'a Owned<U>, Output = O> + Rem<&'a U::Is, Output = O>,
    for<'a> T: RefRem<Owned<U>, Output = O> + RefRem<&'a Owned<U>, Output = O> + RefRem<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the % operator.

fn rem(self, rhs: U) -> Self::Output

Performs the % operation.

impl<T: ?Sized + ToOwned, U: AsIs, O> Shl<U> for Is<'_, T>where
    for<'a> T::Owned: Shl<Owned<U>, Output = O> + Shl<&'a Owned<U>, Output = O> + Shl<&'a U::Is, Output = O>,
    for<'a> T: RefShl<Owned<U>, Output = O> + RefShl<&'a Owned<U>, Output = O> + RefShl<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the << operator.

fn shl(self, rhs: U) -> Self::Output

Performs the << operation.

impl<T: ?Sized + ToOwned, U: AsIs, O> Shr<U> for Is<'_, T>where
    for<'a> T::Owned: Shr<Owned<U>, Output = O> + Shr<&'a Owned<U>, Output = O> + Shr<&'a U::Is, Output = O>,
    for<'a> T: RefShr<Owned<U>, Output = O> + RefShr<&'a Owned<U>, Output = O> + RefShr<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the >> operator.

fn shr(self, rhs: U) -> Self::Output

Performs the >> operation.

impl<T: ?Sized + ToOwned, U: AsIs, O> Sub<U> for Is<'_, T>where
    for<'a> T::Owned: Sub<Owned<U>, Output = O> + Sub<&'a Owned<U>, Output = O> + Sub<&'a U::Is, Output = O>,
    for<'a> T: RefSub<Owned<U>, Output = O> + RefSub<&'a Owned<U>, Output = O> + RefSub<&'a U::Is, Output = O>,

type Output = O

The resulting type after applying the - operator.

fn sub(self, rhs: U) -> Self::Output

Performs the - operation.

impl<T: ?Sized + ToOwned> Eq for Is<'_, T>where
    T: Eq,