Struct Weak

pub struct Weak<T>(/* private fields */);

A weakly-held reference.

Similar to an alloc::sync::Weak.

A Weak does not make any claim to the live-ness of the underlying data. Holders of a Weak must attempt to upgrade to a Strong through Weak::upgrade to access the underlying data.

Note that Weak’s implementation of Hash and PartialEq operate on the pointer itself and not the underlying data.

Implementations

impl<T> Weak<T>

pub fn ptr_eq(&self, Self: &Self) -> bool

Returns true if the two pointers point to the same allocation.

pub fn debug_id(&self) -> impl Debug

Returns core::fmt::Debug implementation that is stable and unique for the data held behind this Weak.

pub fn upgrade(&self) -> Option<Strong<T>>

Attempts to upgrade to a Strong.

Returns None if the inner value has since been marked for destruction.

pub fn strong_count(&self) -> usize

Gets the number of Primary and Strong references to this allocation.

pub fn debug_references(&self) -> DebugReferences<T>

Creates a DebugReferences instance.

Trait Implementations

impl<T> Clone for Weak<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Weak<T>

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

Formats the value using the given formatter.

impl<T> Hash for Weak<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for Weak<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Eq for Weak<T>