Struct taskchampion::Replica

pub struct Replica { /* fields omitted */ }

A replica represents an instance of a user's task data, providing an easy interface for querying and modifying that data.

Implementations

impl Replica

pub fn new(storage: Box<dyn TaskStorage>) -> Replica

pub fn from_config(config: ReplicaConfig) -> Fallible<Replica>

pub fn all_tasks(&mut self) -> Fallible<HashMap<Uuid, Task>>

Get all tasks represented as a map keyed by UUID

pub fn all_task_uuids(&mut self) -> Fallible<Vec<Uuid>>

Get the UUIDs of all tasks

pub fn working_set(&mut self) -> Fallible<Vec<Option<Task>>>

Get the "working set" for this replica -- the set of pending tasks, as indexed by small integers

pub fn get_task(&mut self, uuid: &Uuid) -> Fallible<Option<Task>>

Get an existing task by its UUID

pub fn get_working_set_task(&mut self, i: usize) -> Fallible<Option<Task>>

Get an existing task by its working set index

pub fn get_working_set_index(&mut self, uuid: &Uuid) -> Fallible<Option<usize>>

Get the working set index for the given task uuid

pub fn new_task(
    &mut self,
    status: Status,
    description: String
) -> Fallible<Task>

Create a new task. The task must not already exist.

pub fn sync(&mut self, server: &mut Box<dyn Server>) -> Fallible<()>

Synchronize this replica against the given server.

pub fn gc(&mut self) -> Fallible<()>

Perform "garbage collection" on this replica. In particular, this renumbers the working set to contain only pending tasks.