Enum bos::Bos

#[non_exhaustive]
pub enum Bos<'b, B: ?Sized, O = B, S: ?Sized = O> where
    B: 'static + ?Sized,
    O: 'static,
    S: 'static + ?Sized,  {
    Borrowed(&'b B),
    Owned(O),
    BorrowedArc(&'b Arc<S>),
    Arc(Arc<S>),
    BorrowedRc(&'b Rc<S>),
    Rc(Rc<S>),
}

Borrowed, Owned or Shared smart pointer.

The enum is currently marked as non_exhaustive and has 'static bounds so we may later add a Static(&'static B) variant or something similar.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Borrowed

Tuple Fields of Borrowed

0: &'b B

Owned

Tuple Fields of Owned

0: O

BorrowedArc

Tuple Fields of BorrowedArc

0: &'b Arc<S>

Arc

Tuple Fields of Arc

0: Arc<S>

BorrowedRc

Tuple Fields of BorrowedRc

0: &'b Rc<S>

Rc

Tuple Fields of Rc

0: Rc<S>

Implementations

impl<'b, B: ?Sized, O, S: ?Sized> Bos<'b, B, O, S>

pub fn into_owned(self) -> O where
    B: ToOwned<Owned = O>,
    S: Clone + Into<O>, 

Extracts the owned data.

Clones the data if it is not already owned.

Examples

Calling into_owned on a Bos::Borrowed clones the inner data.

use bos::{Bos, BosStr};

let bos: BosStr = Bos::Borrowed("Hello!");
let owned: String = bos.into_owned();
assert_eq!(owned, "Hello!");

Calling into_owned on a Bos::Owned doesn’t clone anything.

use bos::{Bos, BosStr};

let bos: BosStr = Bos::Owned("Hello!".to_owned());
let owned: String = bos.into_owned();
assert_eq!(owned, "Hello!");

Calling into_owned on a Bos::Arc or Bos::Rc only clones the inner data if the reference count is greater than one.

use bos::{Bos, BosStr};

let bos: BosStr = Bos::Rc("Hello!".to_owned().into());
let owned: String = bos.into_owned();
assert_eq!(owned, "Hello!");

pub fn to_mut(&mut self) -> &mut O where
    B: ToOwned<Owned = O>,
    S: Clone + BorrowMut<O>, 

Acquires a mutable reference to the owned form of the data.

Clones the data if it is not already owned.

Examples

Calling to_mut on a Bos::Borrowed clones the inner data.

use bos::{Bos, BosStr};

let mut hello: BosStr = Bos::Borrowed("Hello");
hello.to_mut().push_str(", Barbara!");
assert_eq!(hello, "Hello, Barbara!");

Calling to_mut on a Bos::Owned doesn’t clone anything.

use bos::{Bos, BosStr};

let mut hello: BosStr = Bos::Owned("Hello".to_owned());
hello.to_mut().push_str(", Barbara!");
assert_eq!(hello, "Hello, Barbara!");

Calling to_mut on a Bos::Arc only clones the inner data if the reference count is greater than one.

use bos::{Bos, BosStr};

let mut hello: BosStr = Bos::Arc("Hello".to_owned().into());
hello.to_mut().push_str(", Barbara!");
assert_eq!(hello, "Hello, Barbara!");

pub fn into_static(self) -> Bos<'static, B, O, S> where
    B: ToOwned<Owned = O>, 

Convert borrowed variants so that the new Bos has a 'static lifetime.

Examples

let b = BosStr::Borrowed("a");
let s = b.into_static();
assert_eq!(s, "a");
assert_matches::assert_matches!(s, BosStr::Owned(_));

pub fn map_shared_to_owned(self) -> Bos<'b, B, O, O> where
    S: Borrow<B>,
    B: ToOwned<Owned = O>, 

Convert Self::Arc from Arc<S> to a new Arc<O>.

This will clone the inner data.

This is unstable and only available with the unstable feature.

pub fn map_shared_to_borrowed(self) -> Bos<'b, B, O, B> where
    S: Borrow<B>,
    for<'a> &'a B: Into<Arc<B>>,
    for<'a> &'a B: Into<Rc<B>>, 

Convert Self::Arc from Arc<S> to a new Arc<B>.

This will clone the inner data.

This is unstable and only available with the unstable feature.

pub fn to_borrowed(&self) -> Bos<'_, B, O, S> where
    O: Borrow<B>, 

Convert to a new Bos that borrows from self.

Examples

let o = BosStr::Owned("a".into());
let b = o.to_borrowed();
assert_eq!(b, "a");
assert_matches::assert_matches!(b, BosStr::Borrowed(_));

let a = BosStr::Rc(String::from("a").into());
let b = a.to_borrowed();
assert_eq!(b, "a");
assert_matches::assert_matches!(b, BosStr::BorrowedRc(_));

pub fn into_shared(self) -> Self where
    O: Into<Rc<S>>, 

Convert Bos::Owned into Bos::Rc.

Examples

let o = BosStr::Owned("a".into());
let s = o.into_shared();
assert_eq!(s, "a");
assert_matches::assert_matches!(s, BosStr::Rc(_));

pub fn clone_shared(&mut self) -> Self where
    O: Default + Clone + Into<Rc<S>>, 

This is unstable and only available with the unstable feature.

pub fn make_shared(&mut self) where
    O: Default,
    O: Into<Rc<S>>, 

Change Bos::Owned into Bos::Rc.

Examples

let mut a = BosStr::Owned("a".into());
a.make_shared();
assert_eq!(a, "a");
assert_matches::assert_matches!(a, BosStr::Rc(_));

Trait Implementations

impl<'b, B: ?Sized, O, S: ?Sized, Rhs> Add<Rhs> for Bos<'b, B, O, S> where
    O: Add<Rhs>,
    B: ToOwned<Owned = O>,
    S: Clone + Into<O>, 

type Output = <O as Add<Rhs>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Rhs) -> <O as Add<Rhs>>::Output

Performs the + operation.

impl<'b, B: ?Sized, O, S: ?Sized, Rhs> AddAssign<Rhs> for Bos<'b, B, O, S> where
    O: AddAssign<Rhs>,
    B: ToOwned<Owned = O>,
    S: Clone + BorrowMut<O>, 

fn add_assign(&mut self, rhs: Rhs)

Performs the += operation.

impl<'b, B: ?Sized, O, S: ?Sized> AsRef<B> for Bos<'b, B, O, S> where
    O: Borrow<B>,
    S: Borrow<B>, 

fn as_ref(&self) -> &B

Performs the conversion.

impl<'b, B: ?Sized, O, S: ?Sized> Borrow<B> for Bos<'b, B, O, S> where
    O: Borrow<B>,
    S: Borrow<B>, 

fn borrow(&self) -> &B

Immutably borrows from an owned value.

impl<'b, B: ?Sized, O, S: ?Sized> Clone for Bos<'b, B, O, S> where
    O: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'b, B: ?Sized, O, S: ?Sized> Debug for Bos<'b, B, O, S> where
    B: Debug,
    O: Debug,
    S: Debug, 

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

Formats the value using the given formatter.

impl<'b, B: ?Sized, O, S: ?Sized> Default for Bos<'b, B, O, S> where
    O: Default, 

fn default() -> Self

Creates an owned Bos with the default value for the contained owned type.

impl<'b, B: ?Sized, O, S: ?Sized> Deref for Bos<'b, B, O, S> where
    O: Borrow<B>,
    S: Borrow<B>, 

type Target = B

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de, 'b, B: ?Sized, O, S: ?Sized> Deserialize<'de> for Bos<'b, B, O, S> where
    O: Deserialize<'de>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'b, B: ?Sized, O, S: ?Sized> Display for Bos<'b, B, O, S> where
    B: Display,
    O: Display,
    S: Display, 

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

Formats the value using the given formatter.

impl<B: ?Sized, O, S: ?Sized> From<&'static B> for Bos<'static, B, O, S>

fn from(x: &'static B) -> Self

Performs the conversion.

impl<'b, B: ?Sized, O, S: ?Sized> From<Arc<S>> for Bos<'b, B, O, S>

fn from(x: Arc<S>) -> Self

Performs the conversion.

impl<'b, T> From<Bos<'b, [T], Vec<T, Global>, Vec<T, Global>>> for Vec<T> where
    T: Clone,
    [T]: ToOwned<Owned = Vec<T>>,
    Vec<T>: Clone, 

fn from(x: Bos<'b, [T], Vec<T>>) -> Self

Performs the conversion.

impl<'b> From<Bos<'b, CStr, CString, CString>> for CString

fn from(x: Bos<'b, CStr, CString>) -> Self

Performs the conversion.

impl<'b> From<Bos<'b, OsStr, OsString, OsString>> for OsString

fn from(x: Bos<'b, OsStr, OsString>) -> Self

Performs the conversion.

impl<'b> From<Bos<'b, Path, PathBuf, PathBuf>> for PathBuf

fn from(x: Bos<'b, Path, PathBuf>) -> Self

Performs the conversion.

impl<'b> From<Bos<'b, str, String, String>> for String

fn from(x: Bos<'b, str, String>) -> Self

Performs the conversion.

impl<'b> From<CString> for Bos<'b, CStr, CString>

fn from(x: CString) -> Self

Performs the conversion.

impl<'b, B: ToOwned + ?Sized + 'b> From<Cow<'b, B>> for Bos<'b, B, B::Owned, B::Owned>

fn from(p: Cow<'b, B>) -> Self

Performs the conversion.

impl<'b> From<OsString> for Bos<'b, OsStr, OsString>

fn from(x: OsString) -> Self

Performs the conversion.

impl<'b> From<PathBuf> for Bos<'b, Path, PathBuf>

fn from(x: PathBuf) -> Self

Performs the conversion.

impl<'b, B: ?Sized, O, S: ?Sized> From<Rc<S>> for Bos<'b, B, O, S>

fn from(x: Rc<S>) -> Self

Performs the conversion.

impl<'b> From<String> for Bos<'b, str, String>

fn from(x: String) -> Self

Performs the conversion.

impl<'b, T> From<Vec<T, Global>> for Bos<'b, [T], Vec<T>>

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

Performs the conversion.

impl<'b, B: ?Sized, O, S: ?Sized> Hash for Bos<'b, B, O, S> where
    B: Hash,
    O: Borrow<B>,
    S: Borrow<B>, 

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, B: ?Sized, O, S: ?Sized> IntoStatic for Bos<'b, B, O, S> where
    B: ToOwned<Owned = O>, 

type Static = Bos<'static, B, O, S>

fn into_static(self) -> Bos<'static, B, O, S>

impl<'b, B: ?Sized, O, S: ?Sized> Ord for Bos<'b, B, O, S> where
    B: Ord,
    O: Borrow<B>,
    S: Borrow<B>, 

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

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'b, B: ?Sized, O, S: ?Sized> PartialEq<&'_ B> for Bos<'b, B, O, S> where
    B: PartialEq,
    O: Borrow<B>,
    S: Borrow<B>, 

fn eq(&self, other: &&B) -> 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<'b, B: ?Sized, O, S: ?Sized> PartialEq<B> for Bos<'b, B, O, S> where
    B: PartialEq,
    O: Borrow<B>,
    S: Borrow<B>, 

fn eq(&self, other: &B) -> 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<'b, B: ?Sized, O, S: ?Sized> PartialEq<Bos<'b, B, O, S>> for Bos<'b, B, O, S> where
    B: PartialEq,
    O: Borrow<B>,
    S: Borrow<B>, 

fn eq(&self, other: &Self) -> 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<'b, B: ?Sized, O, S: ?Sized> PartialOrd<&'_ B> for Bos<'b, B, O, S> where
    B: PartialOrd,
    O: Borrow<B>,
    S: Borrow<B>, 

fn partial_cmp(&self, other: &&B) -> 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<'b, B: ?Sized, O, S: ?Sized> PartialOrd<B> for Bos<'b, B, O, S> where
    B: PartialOrd,
    O: Borrow<B>,
    S: Borrow<B>, 

fn partial_cmp(&self, other: &B) -> 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<'b, B: ?Sized, O, S: ?Sized> PartialOrd<Bos<'b, B, O, S>> for Bos<'b, B, O, S> where
    B: PartialOrd,
    O: Borrow<B>,
    S: Borrow<B>, 

fn partial_cmp(&self, other: &Self) -> 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<'b, B: ?Sized, O, S: ?Sized> Serialize for Bos<'b, B, O, S> where
    B: Serialize,
    O: Serialize + Borrow<B>,
    S: Serialize + Borrow<B>, 

fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error> where
    Ser: Serializer, 

Serialize this value into the given Serde serializer.

impl<'r, 'b, B: ?Sized, O, S: ?Sized> ToBorrowed for &'r Bos<'b, B, O, S> where
    O: Borrow<B>, 

type Borrowed = Bos<'r, B, O, S>

fn to_borrowed(self) -> Bos<'r, B, O, S>

impl<'b, B: ?Sized, O, S: ?Sized> Eq for Bos<'b, B, O, S> where
    B: Eq,
    O: Borrow<B>,
    S: Borrow<B>,