Struct lifeguard::Recycled

pub struct Recycled<'a, T: 'a> where
    T: Recycleable,  { /* fields omitted */ }

A smartpointer which uses a shared reference (&) to know when to move its wrapped value back to the Pool that issued it.

Implementations

impl<'a, T> Recycled<'a, T> where
    T: Recycleable, 

pub fn detach(self) -> T

Disassociates the value from the Pool that issued it. This destroys the smartpointer and returns the previously wrapped value.

Trait Implementations

impl<'a, T> AsMut<T> for Recycled<'a, T> where
    T: Recycleable, 

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

Gets a mutable reference to the value wrapped by the smartpointer.

impl<'a, T> AsRef<T> for Recycled<'a, T> where
    T: Recycleable, 

pub fn as_ref(&self) -> &T

Gets a shared reference to the value wrapped by the smartpointer.

impl<'a, T> Clone for Recycled<'a, T> where
    T: Clone + Recycleable, 

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for Recycled<'a, T> where
    T: Debug + Recycleable, 

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

Formats the value using the given formatter.

impl<'a, T> Deref for Recycled<'a, T> where
    T: Recycleable, 

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &T

Dereferences the value.

impl<'a, T> DerefMut for Recycled<'a, T> where
    T: Recycleable, 

pub fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T> Display for Recycled<'a, T> where
    T: Display + Recycleable, 

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

Formats the value using the given formatter.

impl<'a, T> Eq for Recycled<'a, T> where
    T: Eq + Recycleable, 

impl<'a, T> Hash for Recycled<'a, T> where
    T: Hash + Recycleable, 

pub fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub 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> Ord for Recycled<'a, T> where
    T: Ord + Recycleable, 

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a, T> PartialEq<Recycled<'a, T>> for Recycled<'a, T> where
    T: PartialEq + Recycleable, 

pub fn eq(&self, other: &Self) -> bool

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, T> PartialOrd<Recycled<'a, T>> for Recycled<'a, T> where
    T: PartialOrd + Recycleable, 

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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