Struct LineageHandle 

pub struct LineageHandle(/* private fields */);

dioring’s handle to a live lineage (DI-D-40): what pushing into the lineage and sealing it take. Cloning it is cheap, and every copy names the same lineage.

Releasing the last copy ends the lineage (DI-D-30): every epoch of it not yet durable is abandoned, and a LineageEnded entry reports it. #[must_use] warns when a returned handle is discarded unused, but not for let _ = ..., which releases it at once, nor for a handle dropped with whatever held it – so keep a copy for as long as the lineage’s work matters. The default lineage never ends this way: the instance holds a copy of its own.

Implementations

impl LineageHandle

pub fn mint(lineage: Lineage, home: Weak<dyn Home>) -> LineageHandle

A handle to lineage, whose last release ends it through home.

pub fn detached(lineage: Lineage) -> LineageHandle

A handle to lineage that ends nothing when released: for a lineage whose instance keeps nothing to end, such as a fake’s one lineage.

pub fn lineage(&self) -> Lineage

The lineage, by its Copy name: what entries, reports and a consumer’s own records use.

pub fn at<E, I>(&self, id: E) -> Tag<'_, DioringIds<E, I>>

where E: EpochId + 'static, I: Instant,

Epoch id of this lineage, as a write or a seal takes it.

pub fn is_homed_at<T>(&self, home: &Arc<T>) -> bool

where T: ?Sized,

Whether this handle reports its release to home. The lineage a handle names and its instance are inputs to mint and detached, so they prove nothing about where the handle came from; the home does, because a caller holding no reference to the instance’s own cannot name it.

pub fn is_last(&self) -> bool

Whether this is the lineage’s only remaining copy.

pub fn take_last(self) -> Result<Lineage, LineageHandle>

Consume the lineage’s last handle without ending the lineage through it, because the caller is ending or retiring it explicitly. Hands the handle back if another copy exists.

Trait Implementations

impl Clone for LineageHandle

fn clone(&self) -> LineageHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineageHandle

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

Formats the value using the given formatter.