Struct RefCount 

pub struct RefCount { /* private fields */ }

Reference count using state layout with LEAKED and IMMORTAL support.

State layout (usize): 64-bit: [destructed] [published] [leaked] [immortal] [60 bits: strong_count] 32-bit: [destructed] [published] [leaked] [immortal] [28 bits: strong_count]

See [IMMORTAL] for what the immortal bit promises.

Implementations

impl RefCount

pub fn new() -> Self

Create a new RefCount with strong count = 1

pub fn get(&self) -> usize

Get current strong count

pub fn is_immortal(&self) -> bool

Whether this object lives for the whole process.

A plain relaxed load: the bit is sticky and is set before the object is shared, so no reader can observe it flipping.

pub fn inc(&self)

Increment strong count

pub fn inc_by(&self, n: usize)

pub fn safe_inc(&self) -> bool

Returns true if successful

pub fn dec(&self) -> bool

Decrement strong count. Returns true when count drops to 0.

pub fn leak(&self)

Mark this object as leaked (interned). It will never be deallocated.

This also makes the object immortal, and RefCount::dec depends on that: leaked and immortal are separate answers — is_leaked means “the string pool owns this copy” and is what pointer-equality key lookups read — but every leaked object is immortal, so dec can decide both from the immortal bit alone.

pub fn make_immortal(&self)

Make this object immortal: every later inc/dec becomes a branch and the object is never deallocated. See [IMMORTAL] for the invariant.

Idempotent, and safe to call on an object that is already interned — the other flags are preserved.

pub fn is_leaked(&self) -> bool

Check if this object is leaked (interned).

pub fn mark_published(&self)

Mark the object as published to a lock-free cache (sticky).

pub fn is_published(&self) -> bool

Trait Implementations

impl Default for RefCount

fn default() -> Self

Returns the “default value” for a type.