Struct taskchampion::WorkingSet

pub struct WorkingSet { /* private fields */ }

A WorkingSet represents a snapshot of the working set from a replica.

A replica’s working set is a mapping from small integers to task uuids for all pending tasks. The small integers are meant to be stable, easily-typed identifiers for users to interact with important tasks.

IMPORTANT: the content of the working set may change at any time that a DB transaction is not in progress, and the data in this type will not be updated automatically. It is up to the caller to decide how long to keep this value, and how much to trust the accuracy of its contents. In practice, the answers are usually “a few milliseconds” and treating unexpected results as non-fatal.

Implementations

impl WorkingSet

pub fn len(&self) -> usize

Get the “length” of the working set: the total number of uuids in the set.

pub fn largest_index(&self) -> usize

Get the largest index in the working set, or zero if the set is empty.

pub fn is_empty(&self) -> bool

True if the length is zero

pub fn by_index(&self, index: usize) -> Option<Uuid>

Get the uuid with the given index, if any exists.

pub fn by_uuid(&self, uuid: Uuid) -> Option<usize>

Get the index for the given uuid, if any

pub fn iter(&self) -> impl Iterator<Item = (usize, Uuid)> + '_

Iterate over pairs (index, uuid), in order by index.