Struct portable_atomic_util::Weak

pub struct Weak<T: ?Sized> { /* private fields */ }

Available on crate features alloc or std only.

A weakly reference counted pointer.

This is an equivalent to std::sync::Weak, but using portable-atomic for synchronization. See the documentation for the standard library’s Weak for more details.

Examples

use portable_atomic_util::Arc;
use std::thread;

let five = Arc::new(5);
let weak_five = Arc::downgrade(&five);

thread::spawn(move || {
    let five = weak_five.upgrade().unwrap();
    assert_eq!(*five, 5);
});

Implementations

impl<T: ?Sized> Weak<T>

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

Try to upgrade this Weak pointer to a strong pointer.

Example

use portable_atomic_util::Arc;

let five = Arc::new(5);

let weak = Arc::downgrade(&five);
assert!(weak.upgrade().is_some());

pub fn strong_count(&self) -> usize

Get the number of strong pointers to this allocation.

pub fn weak_count(&self) -> usize

Get the number of weak pointers to this allocation.

impl<T> Weak<T>

pub fn new() -> Self

Create a new dangling Weak pointer.

Example

use portable_atomic_util::Weak;

let weak = Weak::<i32>::new();

Trait Implementations

impl<T: ?Sized> 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: ?Sized> Debug for Weak<T>

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

Formats the value using the given formatter.

impl<T> Default for Weak<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> Drop for Weak<T>

fn drop(&mut self)

Executes the destructor for this type.

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

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