Skip to main content

PoolGuard

Struct PoolGuard 

Source
pub struct PoolGuard<'a, T: Send, F: Fn() -> T, const MAX_POOL_STACKS: usize>(/* private fields */);
Expand description

A guard that is returned when a caller requests a value from the pool.

The purpose of the guard is to use RAII to automatically put the value back in the pool once it’s dropped.

Implementations§

Source§

impl<'a, T: Send, F: Fn() -> T, const MAX_POOL_STACKS: usize> PoolGuard<'a, T, F, MAX_POOL_STACKS>

Source

pub fn put(this: PoolGuard<'_, T, F, MAX_POOL_STACKS>)

Consumes this guard and puts it back into the pool.

This circumvents the guard’s Drop implementation. This can be useful in circumstances where the automatic Drop results in poorer codegen, such as calling non-inlined functions.

Trait Implementations§

Source§

impl<'a, T: Send + Debug, F: Fn() -> T, const MAX_POOL_STACKS: usize> Debug for PoolGuard<'a, T, F, MAX_POOL_STACKS>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, T: Send, F: Fn() -> T, const MAX_POOL_STACKS: usize> Deref for PoolGuard<'a, T, F, MAX_POOL_STACKS>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<'a, T: Send, F: Fn() -> T, const MAX_POOL_STACKS: usize> DerefMut for PoolGuard<'a, T, F, MAX_POOL_STACKS>

Source§

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

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> Freeze for PoolGuard<'a, T, F, MAX_POOL_STACKS>

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> RefUnwindSafe for PoolGuard<'a, T, F, MAX_POOL_STACKS>

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> Send for PoolGuard<'a, T, F, MAX_POOL_STACKS>
where F: Send + Sync,

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> Sync for PoolGuard<'a, T, F, MAX_POOL_STACKS>
where F: Send + Sync, T: Sync,

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> Unpin for PoolGuard<'a, T, F, MAX_POOL_STACKS>

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> UnsafeUnpin for PoolGuard<'a, T, F, MAX_POOL_STACKS>

§

impl<'a, T, F, const MAX_POOL_STACKS: usize> UnwindSafe for PoolGuard<'a, T, F, MAX_POOL_STACKS>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.