Struct atomic_borrow::AtomicBorrow

#[repr(transparent)]
pub struct AtomicBorrow { /* private fields */ }

An atomic reference counter.

Implementations

impl AtomicBorrow

pub const SHARED_MASK: usize = 9_223_372_036_854_775_807usize

The mask for the shared borrow count.

pub const UNIQUE_MASK: usize = 9_223_372_036_854_775_808usize

The mask for the unique borrow bit.

pub const fn new() -> Self

Creates a new AtomicBorrow.

pub fn shared_count(&self) -> usize

Returns number of shared borrows.

pub fn is_unique(&self) -> bool

Returns true if self is uniquely borrowed.

pub fn is_borrowed(&self) -> bool

Returns true if self is borrowed in any way.

pub fn borrow(&self) -> bool

Tries to acquire a shared reference.

Returns true if the reference was acquired.

pub fn borrow_mut(&self) -> bool

Tries to acquire a unique reference.

Returns true if the reference was acquired.

pub fn release(&self)

Releases a shared reference.

Panics.

• If self is not borrowed. Only with debug_assertions enabled.
• If self is uniquely borrowed. Only with debug_assertions enabled.

pub fn release_mut(&self)

Releases a unique reference.

Panics.

• If self is not uniquely borrowed. Only with debug_assertions enabled.

pub fn spin_borrow(&self)

Spins until a shared reference can be acquired.

pub fn spin_borrow_mut(&self)

Spins until a unique reference can be acquired.

Trait Implementations

impl Debug for AtomicBorrow

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

Formats the value using the given formatter.

impl Default for AtomicBorrow

fn default() -> AtomicBorrow

Returns the “default value” for a type.