RawBlindPooled

Struct RawBlindPooled 

Source
pub struct RawBlindPooled<T>
where T: ?Sized,
{ /* private fields */ }
Expand description

A shared handle to an object in a RawBlindPool. The handle can be used to access the pooled object, as well as to remove it from the pool when no longer needed.

This is a raw handle that requires manual lifetime management of the pooled objects.

  • Accessing the target object is only possible via unsafe code as the handle does not know when the pool has been dropped - the caller must guarantee the pool still exists.
  • You must explicitly remove the target object from the pool when it is no longer needed. If the handle is merely dropped, the object it references remains in the pool until the pool itself is dropped. This is a shared handle that only grants shared access to the object. No exclusive references can be created through this handle. All handles become invalid once the object is removed from the pool or the pool is dropped.

§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§

Source§

impl<T: ?Sized> RawBlindPooled<T>

Source

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.

Source

pub unsafe 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.

§Safety

The caller must guarantee that the pool will remain alive for the duration the returned reference is used.

Source

pub unsafe fn as_ref(&self) -> &T

Borrows the target object as a shared reference.

§Safety

The caller must guarantee that the pool will remain alive for the duration the returned reference is used.

Source

pub fn erase(self) -> RawBlindPooled<()>
where T: Send + Sync,

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

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§

Source§

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

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

impl<T: ?Sized> From<RawBlindPooledMut<T>> for RawBlindPooled<T>

Source§

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

Converts to this type from the input type.
Source§

impl<T: ?Sized> Copy for RawBlindPooled<T>

Auto Trait Implementations§

§

impl<T> Freeze for RawBlindPooled<T>
where T: ?Sized,

§

impl<T> RefUnwindSafe for RawBlindPooled<T>
where T: RefUnwindSafe + ?Sized,

§

impl<T> Send for RawBlindPooled<T>
where T: Sync + ?Sized,

§

impl<T> !Sync for RawBlindPooled<T>

§

impl<T> Unpin for RawBlindPooled<T>
where T: ?Sized,

§

impl<T> UnwindSafe for RawBlindPooled<T>
where T: RefUnwindSafe + ?Sized,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.