Struct PooledMut 

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

A unique thread-safe reference-counting handle for a pooled object. 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 unique handle, guaranteeing that no other handles to the same object exist. You may create both shared and exclusive references to the object through this handle. The handle may also be converted to a shared handle via .into_shared().

Thread safety

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

If the underlying object is Sync, the handle is thread-mobile (Send). Otherwise, the handle is single-threaded (neither Send nor Sync).

Implementations

impl<T: ?Sized> PooledMut<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 into_shared(self) -> Pooled<T>

Transforms the unique handle into a shared handle that can be cloned as needed.

A shared handle does not support the creation of exclusive references to the target object.

Thread Safety

The resulting shared handle will only be Send if T: Send + Sync. This is a stronger requirement than for unique handles, which only require T: Send.

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 as_pin_mut(&mut self) -> Pin<&mut T>

Borrows the target object as a pinned exclusive reference.

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

impl<T> PooledMut<T>

where T: Unpin,

pub fn into_inner(self) -> T

Removes the item from the pool and returns it to the caller.

Trait Implementations

impl<T> AsMut<T> for PooledMut<T>

where T: ?Sized + Unpin,

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

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

impl<T: ?Sized> AsRef<T> for PooledMut<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 PooledMut<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for PooledMut<T>

where T: ?Sized + Unpin,

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

Mutably borrows from an owned value.

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for PooledMut<T>

where T: ?Sized + Unpin,

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

Mutably dereferences the value.

impl<T: ?Sized> Drop for PooledMut<T>

fn drop(&mut self)

Executes the destructor for this type.

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

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

Converts to this type from the input type.