Struct rob::Rob

pub struct Rob<'a, T: 'a + ?Sized> { /* fields omitted */ }

The Rob type. See the crate documentation.

Methods

impl<'a, T: 'a> Rob<'a, T>

pub fn from_value(value: T) -> Self

Creates a new Rob with an owned value.

Example

let x = rob::Rob::from_value(123i32);
assert_eq!(*x, 123);
assert!(rob::Rob::is_owned(&x));

impl<'a, T: 'a + ?Sized> Rob<'a, T>

pub fn from_ref(r: &'a T) -> Self

Creates a new Rob with a borrowed reference.

Example

let value = 123i32;
let x = rob::Rob::from_ref(&value);
assert_eq!(*x, 123);
assert!(!rob::Rob::is_owned(&x));

pub fn from_box(b: Box<T>) -> Self

Creates a new Rob with an owned value that is already boxed.

Example

let x = rob::Rob::from_box(Box::new(123i32));
assert_eq!(*x, 123);
assert!(rob::Rob::is_owned(&x));

pub unsafe fn from_raw(ptr: *mut T, is_owned: bool) -> Self

Creates a new Rob from a raw pointer and an owned flag. If is_owned is true, ptr should come from Box::into_raw.

pub fn into_raw(this: Self) -> (*mut T, bool)

Consumes this, returning a raw pointer to the value and a flag indicating whether the values is owned or not.

pub fn as_ref(this: &Self) -> Option<&'a T>

If the value is not owned, returns a reference to it with lifetime 'a.

pub fn is_owned(this: &Self) -> bool

Returns whether the value is owned or not.

impl<'a, T: 'a + ?Sized> Rob<'a, T> where
    T: ToOwned,
    <T as ToOwned>::Owned: Into<Box<T>>, 

pub fn into_box(this: Self) -> Box<T>

Consumes this, returning a Box containing the value, cloning it if it was not owned.

pub fn to_mut(this: &mut Self) -> &mut T

Returns a mutable reference to the value, cloning it if it was not owned.

Trait Implementations

impl<'a, T: 'a + ?Sized> Drop for Rob<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: 'a> From<T> for Rob<'a, T>

fn from(value: T) -> Self

Performs the conversion.

impl<'a, T: 'a + ?Sized> From<&'a T> for Rob<'a, T>

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

Performs the conversion.

impl<'a, T: 'a + ?Sized> From<Box<T>> for Rob<'a, T>

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

Performs the conversion.

impl<'a, T: 'a> From<Vec<T>> for Rob<'a, [T]>

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

Performs the conversion.

impl<'a> From<String> for Rob<'a, str>

fn from(s: String) -> Self

Performs the conversion.

impl<'a> From<CString> for Rob<'a, CStr>

fn from(s: CString) -> Self

Performs the conversion.

impl<'a> From<OsString> for Rob<'a, OsStr>

fn from(s: OsString) -> Self

Performs the conversion.

impl<'a> From<PathBuf> for Rob<'a, Path>

fn from(s: PathBuf) -> Self

Performs the conversion.

impl<'a, T> From<Cow<'a, T>> for Rob<'a, T> where
    T: ToOwned,
    <T as ToOwned>::Owned: Into<Box<T>>, 

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

Performs the conversion.

impl<'a, T: 'a + Clone> Clone for Rob<'a, T>

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: 'a + ?Sized + Debug> Debug for Rob<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: 'a + ?Sized + Hash> Hash for Rob<'a, 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<'a, T: 'a + ?Sized + PartialEq> PartialEq for Rob<'a, T>

fn eq(&self, other: &Rob<'a, T>) -> bool

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

fn ne(&self, other: &Rob<'a, T>) -> bool

This method tests for !=.

impl<'a, T: 'a + ?Sized + PartialOrd> PartialOrd for Rob<'a, T>

fn partial_cmp(&self, other: &Rob<'a, T>) -> Option<Ordering>

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

fn lt(&self, other: &Rob<'a, T>) -> bool

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

fn le(&self, other: &Rob<'a, T>) -> bool

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

fn ge(&self, other: &Rob<'a, T>) -> bool

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

fn gt(&self, other: &Rob<'a, T>) -> bool

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

impl<'a, T: 'a + ?Sized> Deref for Rob<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: 'a + ?Sized> Borrow<T> for Rob<'a, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T: 'a + ?Sized> AsRef<T> for Rob<'a, T>

fn as_ref(&self) -> &T

Performs the conversion.