Struct CWeak 

pub struct CWeak<T, TAllocator: Allocator> { /* private fields */ }

A weak reference to the underlying CArc.

This object cannot inspect the underlying value (unless T is Copy). But it does track weak references, and each weak reference can build a strong reference, assuming any other strong reference is alive.

Implementations

impl<T, TAllocator: Allocator> CWeak<T, TAllocator>

pub fn strong_count(&self) -> u32

Returns the number of strong references to the CWeak.

pub fn weak_count(&self) -> u32

Returns the number of weak references to the CWeak.

pub fn data(&self) -> &T

where T: Copy,

Returns a reference to the underlying data.

This function is only available if T implements Copy. That is because being Copy means it is not Drop. And so we don’t need strong references to keep the data alive.

pub fn upgrade(&self) -> Result<CArc<T, TAllocator>, WeakUpgradeError>

Upgrades current weak reference to the strong CArc.

Errors

For details see WeakUpgradeError.

pub fn abandon(self) -> bool

Abandons current weak reference.

If the internal weak counter is positive it returns false.

Otherwise it deallocates the underlying memory and returns true. In particular only single (the last) CWeak returns true by calling this.

Trait Implementations

impl<T, TAllocator: Allocator> Clone for CWeak<T, TAllocator>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, TAllocator: Debug + Allocator> Debug for CWeak<T, TAllocator>

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

Formats the value using the given formatter.

impl<T, TAllocator: Allocator> Drop for CWeak<T, TAllocator>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: ReprC, TAllocator: Allocator> ReprC for CWeak<T, TAllocator>

const CHECK: ()

This field is used for const checks only.

impl<T, TAllocator: Allocator> TryClone for CWeak<T, TAllocator>

type Error = MaxReferencesExceededError

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the type.