Struct Pooled

pub struct Pooled<T: Default + Reset> { /* private fields */ }

An object taken from a Pool.

When dropped, it will be Reset and returned to the pool if it has spare capacity.

Implementations

impl<T: Default + Reset> Pooled<T>

pub fn detach(this: Self) -> T

Detach this object from the pool.

It will not be returned to the pool once dropped.

let pool: Pool<String> = Pool::new(69);
let foo: Pooled<String> = pool.take();
assert_eq!(pool.in_use(), 1);

let foo: String = Pooled::detach(foo);
assert_eq!(pool.in_use(), 0);

pub fn get_pool(this: &Self) -> Option<Pool<T>>

Get the pool associated with this object.

Objects can outlive the pool they came from, so this returns an Option.

let pool = Pool::<String>::new(69);
let foo = pool.take();
assert!(Pooled::get_pool(&foo).is_some());
drop(pool);
assert!(Pooled::get_pool(&foo).is_none());

Trait Implementations

impl<T: Default + Reset> AsMut<T> for Pooled<T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: Default + Reset> AsRef<T> for Pooled<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Default + Reset> Borrow<T> for Pooled<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Default + Reset> BorrowMut<T> for Pooled<T>

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

Mutably borrows from an owned value.

impl<T> Debug for Pooled<T>

where T: Debug + Default + Reset,

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

Formats the value using the given formatter.

impl<T: Default + Reset> Deref for Pooled<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Default + Reset> DerefMut for Pooled<T>

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

Mutably dereferences the value.

impl<T> Display for Pooled<T>

where T: Display + Default + Reset,

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

Formats the value using the given formatter.

impl<T: Default + Reset> Drop for Pooled<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Hash for Pooled<T>

where T: Hash + Default + Reset,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Pooled<T>

where T: Ord + Default + Reset,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq<T> for Pooled<T>

where T: PartialEq<T> + Default + Reset,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq for Pooled<T>

where T: PartialEq<T> + Default + Reset,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Default + Reset + PartialOrd<T>> PartialOrd<T> for Pooled<T>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T> PartialOrd for Pooled<T>

where T: PartialOrd<T> + Default + Reset,

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

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T> Eq for Pooled<T>

where T: Eq + Default + Reset,