Struct PinWeak 

pub struct PinWeak<T: ?Sized>(/* private fields */);

PinWeak<T> represents a non-owning reference to a pinned value managed by a Pin<HybridRc<T, _>>.

The typical way to obtain a PinWeak<T> is to call HybridRc::downgrade_pin().

See Weak<T> for more information about weak references.

Implementations

impl<T: ?Sized> PinWeak<T>

pub fn upgrade_local(&self) -> Result<Pin<Rc<T>>, UpgradeError>

Attempts to upgrade the pinned weak pointer to a pinned Rc.

See Weak::upgrade_local() for more information.

Errors

• ValueDropped: the referenced value has already been dropped.
• WrongThread: another thread currently holds Rcs for the value.

pub fn upgrade(&self) -> Result<Pin<Arc<T>>, UpgradeError>

Attempts to upgrade the pinned weak pointer to a pinned Arc.

See Weak::upgrade() for more information.

Errors

• ValueDropped: the referenced value has already been dropped.

pub fn strong_count(&self) -> usize

Gets a lower bound to the number of strong pointers to the inner value.

See Weak::strong_count() for more information.

pub fn weak_count(&self) -> usize

Gets the number of Weak pointers to this allocation.

See Weak::strong_count() for more information.

pub unsafe fn into_inner_unchecked(self) -> Weak<T>

Transforms this PinWeak<T> into a Weak<T>

Safety

This function is unsafe. You must guarantee that you will continue to treat the Weak as pinned after you call this function. Not maintaining the pinning invariants that is a violation of the API contract and may lead to undefined behavior in later (safe) operations.

If the underlying data is Unpin, PinWeak::into_inner() should be used instead.

impl<T> PinWeak<T>

pub fn new() -> PinWeak<T>

Constructs a dummy PinWeak<T>, without allocating any memory.

Trying to upgrade the result will always result in a ValueDropped error.

impl<T: ?Sized + Unpin> PinWeak<T>

pub fn into_inner(self) -> Weak<T>

Transforms this PinWeak<T> into a Weak<T>

This requires that the data inside the shared allocation is Unpin, so that we can ignore the pinning invariants when unwrapping it.

Trait Implementations

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

fn clone(&self) -> Self

Creates another pinned weak reference for the same value.

See Weak::clone() for more information.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Default for PinWeak<T>

fn default() -> Self

Constructs a dummy PinWeak<T>, without allocating any memory.

See PinWeak<T>::new().

impl<T: ?Sized> Pointer for PinWeak<T>

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

Formats the value using the given formatter.

If the # flag is used, the state (weak) is written after the address.

impl<T: ?Sized + Sync + Send> Send for PinWeak<T>

impl<T: ?Sized + Sync + Send> Sync for PinWeak<T>