Struct opool::RefGuard

pub struct RefGuard<'a, P: PoolAllocator<T>, T> { /* private fields */ }

A struct representing a guard over an object in the pool.

This struct ensures that the object is returned to the pool when it is dropped.

Implementations

impl<'a, P: PoolAllocator<T>, T> RefGuard<'a, P, T>

pub fn into_inner(self) -> T

Consumes the guard and returns the object, without returning it to the pool.

This method should be used with caution, as it leads to objects not being returned to the pool.

Trait Implementations

impl<'a, P: PoolAllocator<T>, T> AsRef<T> for RefGuard<'a, P, T>

fn as_ref(&self) -> &T

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

impl<'a, P: PoolAllocator<T>, T> Borrow<T> for RefGuard<'a, P, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, P: PoolAllocator<T>, T: Debug> Debug for RefGuard<'a, P, T>

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

Formats the value using the given formatter.

impl<'a, P: PoolAllocator<T>, T> Deref for RefGuard<'a, P, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, P: PoolAllocator<T>, T> DerefMut for RefGuard<'a, P, T>

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

Mutably dereferences the value.

impl<'a, P: PoolAllocator<T>, T: Display> Display for RefGuard<'a, P, T>

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

Formats the value using the given formatter.

impl<'a, P: PoolAllocator<T>, T> Drop for RefGuard<'a, P, T>

Implementation of the Drop trait for Guard.

This ensures that the object is returned to the pool when the guard is dropped, unless the object fails validation.

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, P: PoolAllocator<T>, T: Hash> Hash for RefGuard<'a, P, 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, P: PoolAllocator<T>, T: Ord> Ord for RefGuard<'a, P, T>

fn cmp(&self, other: &RefGuard<'a, P, T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a, P: PoolAllocator<T>, T: PartialEq> PartialEq<RefGuard<'a, P, T>> for RefGuard<'a, P, T>

fn eq(&self, other: &RefGuard<'a, P, T>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, P: PoolAllocator<T>, T: PartialOrd> PartialOrd<RefGuard<'a, P, T>> for RefGuard<'a, P, T>

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

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

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

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

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

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

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

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

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

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

impl<'a, P: PoolAllocator<T>, T> Pointer for RefGuard<'a, P, T>

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

Formats the value using the given formatter.

impl<'a, P: PoolAllocator<T>, T: Eq> Eq for RefGuard<'a, P, T>