Struct taskchampion::Task

pub struct Task { /* fields omitted */ }

A task, as publicly exposed by this crate.

Note that Task objects represent a snapshot of the task at a moment in time, and are not protected by the atomicity of the backend storage. Concurrent modifications are safe, but a Task that is cached for more than a few seconds may cause the user to see stale data. Fetch, use, and drop Tasks quickly.

This struct contains only getters for various values on the task. The into_mut method returns a TaskMut which can be used to modify the task.

Implementations

impl Task

pub fn get_uuid(&self) -> Uuid

pub fn get_taskmap(&self) -> &TaskMap

pub fn into_mut(self, replica: &mut Replica) -> TaskMut<'_>

Prepare to mutate this task, requiring a mutable Replica in order to update the data it contains.

pub fn get_status(&self) -> Status

pub fn get_description(&self) -> &str

pub fn get_wait(&self) -> Option<DateTime<Utc>>

Get the wait time. If this value is set, it will be returned, even if it is in the past.

pub fn is_waiting(&self) -> bool

Determine whether this task is waiting now.

pub fn is_active(&self) -> bool

Determine whether this task is active – that is, that it has been started and not stopped.

pub fn has_tag(&self, tag: &Tag) -> bool

Check if this task has the given tag

pub fn get_tags(&self) -> impl Iterator<Item = Tag> + '_

Iterate over the task’s tags

pub fn get_modified(&self) -> Option<DateTime<Utc>>

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl PartialEq<Task> for Task

fn eq(&self, other: &Task) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Task) -> bool

This method tests for !=.

impl StructuralPartialEq for Task