Struct beef::generic::Cow

pub struct Cow<'a, T: Beef + ?Sized + 'a, U: Capacity> { /* fields omitted */ }

A clone-on-write smart pointer, mostly compatible with std::borrow::Cow.

This type is using a generic U: Capacity. Use either beef::Cow or beef::lean::Cow in your code.

Implementations

impl<T: ?Sized, U, '_> Cow<'_, T, U> where
    T: Beef,
    U: Capacity, 

pub fn owned(val: T::Owned) -> Self

Owned data.

Example

use beef::Cow;

let owned: Cow<str> = Cow::owned("I own my content".to_string());

impl<'a, T: ?Sized, U> Cow<'a, T, U> where
    T: Beef,
    U: Capacity, 

pub fn borrowed(val: &'a T) -> Self

Borrowed data.

Example

use beef::Cow;

let borrowed: Cow<str> = Cow::borrowed("I'm just a borrow");

pub fn into_owned(self) -> T::Owned

Extracts the owned data.

Clones the data if it is not already owned.

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

Extracts borrowed data.

Panics: If the data is owned.

pub fn is_borrowed(&self) -> bool

Returns true if data is borrowed or had no capacity.

Example

use beef::Cow;

let borrowed: Cow<str> = Cow::borrowed("Borrowed");
let no_capacity: Cow<str> = Cow::owned(String::new());
let owned: Cow<str> = Cow::owned(String::from("Owned"));

assert_eq!(borrowed.is_borrowed(), true);
assert_eq!(no_capacity.is_borrowed(), true);
assert_eq!(owned.is_borrowed(), false);

pub fn is_owned(&self) -> bool

Returns true if data is owned and has non-0 capacity.

Example

use beef::Cow;

let borrowed: Cow<str> = Cow::borrowed("Borrowed");
let no_capacity: Cow<str> = Cow::owned(String::new());
let owned: Cow<str> = Cow::owned(String::from("Owned"));

assert_eq!(borrowed.is_owned(), false);
assert_eq!(no_capacity.is_owned(), false);
assert_eq!(owned.is_owned(), true);

impl<'a> Cow<'a, str, Wide>

pub const fn const_str(val: &'a str) -> Self

Borrowed data.

This is functionally identical to borrow. We use impl specialization to allow this function to be const.

Example

use beef::Cow;

const HELLO: Cow<str> = Cow::const_str("Hello");

impl<'a> Cow<'a, str, Lean>

pub const fn const_str(val: &'a str) -> Self

Borrowed data.

This is functionally identical to borrow. We use impl specialization to allow this function to be const.

Example

use beef::lean::Cow;

const HELLO: Cow<str> = Cow::const_str("Hello");

Trait Implementations

impl<T: ?Sized, U, '_> AsRef<T> for Cow<'_, T, U> where
    T: Beef,
    U: Capacity, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: ?Sized, U, '_> Borrow<T> for Cow<'_, T, U> where
    T: Beef,
    U: Capacity, 

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T: ?Sized, U> Clone for Cow<'a, T, U> where
    T: Beef,
    U: Capacity, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized, U, '_> Debug for Cow<'_, T, U> where
    T: Beef + Debug,
    U: Capacity, 

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

Formats the value using the given formatter.

impl<'a, T: ?Sized, U> Default for Cow<'a, T, U> where
    T: Beef,
    U: Capacity,
    &'a T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<T: ?Sized, U, '_> Deref for Cow<'_, T, U> where
    T: Beef,
    U: Capacity, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized, U, '_> Display for Cow<'_, T, U> where
    T: Beef + Display,
    U: Capacity, 

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

Formats the value using the given formatter.

impl<T: ?Sized, U, '_> Drop for Cow<'_, T, U> where
    T: Beef,
    U: Capacity, 

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized, U, '_> Eq for Cow<'_, T, U> where
    T: Eq + Beef,
    U: Capacity, 

impl<'a, T: ?Sized, U> From<&'a T> for Cow<'a, T, U> where
    T: Beef,
    U: Capacity, 

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

Performs the conversion.

impl<'a, T: ?Sized, U> From<Cow<'a, T, U>> for StdCow<'a, T> where
    T: Beef,
    U: Capacity, 

fn from(cow: Cow<'a, T, U>) -> Self

Performs the conversion.

impl<'a, T: ?Sized, U> From<Cow<'a, T>> for Cow<'a, T, U> where
    T: Beef,
    U: Capacity, 

fn from(stdcow: StdCow<'a, T>) -> Self

Performs the conversion.

impl<U, '_> From<String> for Cow<'_, str, U> where
    U: Capacity, 

fn from(s: String) -> Self

Performs the conversion.

impl<T, U, '_> From<Vec<T>> for Cow<'_, [T], U> where
    T: Clone,
    U: Capacity, 

fn from(v: Vec<T>) -> Self

Performs the conversion.

impl<T: ?Sized, U, '_> Hash for Cow<'_, T, U> where
    T: Hash + Beef,
    U: Capacity, 

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, U, '_> Ord for Cow<'_, T, U> where
    T: Ord + Beef,
    U: Capacity, 

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<U, T, '_, '_> PartialEq<&'_ [T]> for Cow<'_, [T], U> where
    U: Capacity,
    T: Clone + PartialEq, 

fn eq(&self, other: &&[T]) -> 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<U, '_, '_> PartialEq<&'_ str> for Cow<'_, str, U> where
    U: Capacity, 

fn eq(&self, other: &&str) -> 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<U, T, '_> PartialEq<[T]> for Cow<'_, [T], U> where
    U: Capacity,
    T: Clone + PartialEq, 

fn eq(&self, other: &[T]) -> 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<U, T, '_> PartialEq<Cow<'_, [T], U>> for [T] where
    U: Capacity,
    T: Clone + PartialEq, 

fn eq(&self, other: &Cow<'_, [T], 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<U, T, '_, '_> PartialEq<Cow<'_, [T], U>> for &'_ [T] where
    U: Capacity,
    T: Clone + PartialEq, 

fn eq(&self, other: &Cow<'_, [T], 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<U, T, '_> PartialEq<Cow<'_, [T], U>> for Vec<T> where
    U: Capacity,
    T: Clone + PartialEq, 

fn eq(&self, other: &Cow<'_, [T], 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<A: ?Sized, B: ?Sized, U, V, '_, '_> PartialEq<Cow<'_, B, V>> for Cow<'_, A, U> where
    A: Beef,
    B: Beef,
    U: Capacity,
    V: Capacity,
    A: PartialEq<B>, 

fn eq(&self, other: &Cow<'_, B, V>) -> 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<U, '_> PartialEq<Cow<'_, str, U>> for str where
    U: Capacity, 

fn eq(&self, other: &Cow<'_, str, 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<U, '_, '_> PartialEq<Cow<'_, str, U>> for &'_ str where
    U: Capacity, 

fn eq(&self, other: &Cow<'_, str, 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<U, '_> PartialEq<Cow<'_, str, U>> for String where
    U: Capacity, 

fn eq(&self, other: &Cow<'_, str, 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<U, '_> PartialEq<String> for Cow<'_, str, U> where
    U: Capacity, 

fn eq(&self, other: &String) -> 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<U, T, '_> PartialEq<Vec<T>> for Cow<'_, [T], U> where
    U: Capacity,
    T: Clone + PartialEq, 

fn eq(&self, other: &Vec<T>) -> 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<U, '_> PartialEq<str> for Cow<'_, str, U> where
    U: Capacity, 

fn eq(&self, other: &str) -> 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<A: ?Sized, B: ?Sized, U, V, '_, '_> PartialOrd<Cow<'_, B, V>> for Cow<'_, A, U> where
    A: Beef + PartialOrd<B>,
    B: Beef,
    U: Capacity,
    V: Capacity, 

fn partial_cmp(&self, other: &Cow<'_, B, V>) -> 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: Beef + Send + ?Sized, U: Capacity, '_> Send for Cow<'_, T, U>

impl<T: Beef + Sync + ?Sized, U: Capacity, '_> Sync for Cow<'_, T, U>