Enum borrowned::BorrownedBox

pub enum BorrownedBox<'b, T: ?Sized> {
    Owned(Box<T>),
    Borrowed(&'b mut T),
}

A smart pointer that either owns or mutably borrows a value.

Example

use borrowned::BorrownedBox;

fn print_text(text: &BorrownedBox<'_, String>) {
    println!("{}", text);
}

let owned = BorrownedBox::Owned(Box::new("hello".to_string()));
let mut owned2 = Box::new("world".to_string());
let borrowed = BorrownedBox::Borrowed(&mut *owned2);

print_text(&owned);
print_text(&borrowed);
print_text(&owned2.into());

Variants

Owned(Box<T>)

Contains the owned value

Borrowed(&'b mut T)

Contains the borrowed value

Implementations

impl<'b, T: ?Sized> BorrownedBox<'b, T>

pub fn try_into_box(self) -> Result<Box<T>, Self>

Extracts the owned data.

Returns self in Err if it's not owned.

pub fn try_into_borrowed(self) -> Result<&'b mut T, Self>

Extracts the borrowed data.

Returns self in Err if it's not borrowed.

Trait Implementations

impl<'b, T: ?Sized> AsMut<T> for BorrownedBox<'b, T>

fn as_mut(&mut self) -> &mut T

Performs the conversion.

impl<'b, T: ?Sized> AsRef<T> for BorrownedBox<'b, T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<'b, T: ?Sized> Borrow<T> for BorrownedBox<'b, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'b, T: ?Sized> BorrowMut<T> for BorrownedBox<'b, T>

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<'b, T: Clone + ?Sized> Clone for BorrownedBox<'b, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'b, T: Debug + ?Sized> Debug for BorrownedBox<'b, T>

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

Formats the value using the given formatter.

impl<'b, T: Default + ?Sized> Default for BorrownedBox<'b, T>

fn default() -> Self

Returns the "default value" for a type.

impl<'b, T: ?Sized> Deref for BorrownedBox<'b, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'b, T: ?Sized> DerefMut for BorrownedBox<'b, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'b, T: Display + ?Sized> Display for BorrownedBox<'b, T>

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

Formats the value using the given formatter.

impl<'b, T: Eq + ?Sized> Eq for BorrownedBox<'b, T>

impl<'b, T: ?Sized> From<&'b mut T> for BorrownedBox<'b, T>

fn from(borrowed: &'b mut T) -> Self

Performs the conversion.

impl<'b, T: ?Sized> From<Box<T>> for BorrownedBox<'b, T>

fn from(owned: Box<T>) -> Self

Performs the conversion.

impl<'b, T: Hash + ?Sized> Hash for BorrownedBox<'b, T>

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<'b, T: Ord> Ord for BorrownedBox<'b, T>

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<'b, T: PartialEq + ?Sized> PartialEq<BorrownedBox<'b, T>> for BorrownedBox<'b, T>

fn eq(&self, other: &Self) -> 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<'b, T: PartialOrd + ?Sized> PartialOrd<BorrownedBox<'b, T>> for BorrownedBox<'b, T>

fn partial_cmp(&self, other: &Self) -> 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.