Struct PokeSmartPointer

pub struct PokeSmartPointer<'mem> { /* private fields */ }

Implementations

impl<'mem> PokeSmartPointer<'mem>

pub fn shape(&self) -> &'static Shape

Returns the shape for this smart pointer.

pub fn def(&self) -> &SmartPointerDef

Returns the smart pointer definition.

pub fn vtable(&self) -> &'static SmartPointerVTable

Returns the smart pointer vtable

pub fn is_weak(&self) -> bool

Returns whether this smart pointer is weak (like std::sync::Weak).

pub fn is_atomic(&self) -> bool

Returns whether this smart pointer is atomic (like std::sync::Arc).

pub fn is_lock(&self) -> bool

Returns whether this pointer is a lock (like std::sync::Mutex).

pub fn known_type(&self) -> Option<KnownSmartPointer>

Gets the known smart pointer type, if available.

pub fn inner_type(&self) -> &'static Shape

Returns the shape of the inner type of the smart pointer.

pub fn try_borrow(&self) -> Option<PeekValue<'_>>

Attempts to borrow the inner value if the smart pointer supports it.

pub fn try_upgrade(&self) -> Option<Self>

Attempts to upgrade this pointer if it’s a weak reference.

pub fn try_lock(&self) -> Option<Result<PokeSmartPointerWriteGuard<'_>, ()>>

Attempts to lock this pointer if it’s a mutex-like smart pointer.

pub fn try_read(&self) -> Option<Result<PokeSmartPointerReadGuard<'_>, ()>>

Attempts to acquire a read lock on this pointer if it’s a reader-writer lock.

pub fn try_write(&self) -> Option<Result<PokeSmartPointerWriteGuard<'_>, ()>>

Attempts to acquire a write lock on this pointer if it’s a reader-writer lock.

pub fn into_value(self) -> PokeValue<'mem>

Get a reference to the underlying PokeValue

pub fn build_in_place<U: Facet>(self) -> U

Moves U out of this PokeSmartPointer.

Note that U should be something like Arc<T>, Rc<T>, etc.