Struct Pooled 

pub struct Pooled<T: ?Sized> { /* private fields */ }

A shared thread-safe reference-counting handle for a pooled object.

Implications of reference counted handles

The handle can be used to access the pooled object.

This is a reference-counted handle that automatically removes the object when the handle is dropped. Dropping the handle is the only way to remove the object from the pool. This is a shared handle that only grants shared access to the object. No exclusive references can be created through this handle.

Thread safety

The handle provides access to an object of type T, so its thread-safety characteristics are determined by the type of the object it references.

If the underlying object T is Send then the handle is Send. If the underlying object T is Sync then the handle is Sync.

Implementations

impl<T: ?Sized> Pooled<T>

pub fn ptr(&self) -> NonNull<T>

Get a pointer to the target object.

All pooled objects are guaranteed to be pinned for their entire lifetime, so this pointer remains valid for as long as the object remains in the pool.

The object pool implementation does not keep any references to the pooled objects, so you have the option of using this pointer to create Rust references directly without fear of any conflicting references created by the pool.

pub fn as_pin(&self) -> Pin<&T>

Borrows the target object as a pinned shared reference.

All pooled objects are guaranteed to be pinned for their entire lifetime.

pub fn erase(self) -> Pooled<()>

Erase the type information from this handle, converting it to Pooled<()>.

This is useful for extending the lifetime of an object in the pool without retaining type information. The type-erased handle prevents access to the object but ensures it remains in the pool.

Trait Implementations

impl<T: ?Sized> 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: ?Sized> Borrow<T> for Pooled<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized> Clone for Pooled<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for Pooled<T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Pooled<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> From<PooledMut<T>> for Pooled<T>

fn from(value: PooledMut<T>) -> Self

Converts to this type from the input type.