Struct tsk_rs::task::Task

pub struct Task {
    pub id: Uuid,
    pub description: String,
    pub done: bool,
    pub project: Option<String>,
    pub tags: Option<Vec<String>>,
    pub metadata: BTreeMap<String, String>,
    pub timetracker: Option<Vec<TimeTrack>>,
}

Task data abstraction as a Rust struct

Fields

id: Uuid

Unique identifier for the task

description: String

Description or a title of the task

done: bool

Is the task completed or not

project: Option<String>

To which project (if any) is this task part of?

tags: Option<Vec<String>>

Tags (if any) for the task that can be used to group several tasks of some kind

metadata: BTreeMap<String, String>

Key, value pairs holding either user added metadata fields prepended with the “x-” string or task management internal metadata.

timetracker: Option<Vec<TimeTrack>>

List of optional TimeTrack entries.

Implementations

impl Task

pub fn loose_match(&self, search: &str) -> bool

Search the task with a string and try to match it to available information. Return true if the task matches.

pub fn is_running(&self) -> bool

Returns true if the task is running

pub fn current_timetrack(&self) -> Option<(usize, TimeTrack)>

Returns current TimeTrack entry for the task if one is running. Returns None if time tracking is not active.

pub fn start(&mut self, annotation: &Option<String>) -> Result<TimeTrack>

Start time tracking for the task and return the TimeTrack entry

pub fn stop(&mut self) -> Result<Option<TimeTrack>>

Stop time tracking for the task. Return the TimeTrack entry that was concluded.

pub fn current_runtime(&self) -> Option<Duration>

Return the runtime (delta of start timestamp of TimeTrack and current timestamp) of a running task.

pub fn load_yaml_file_from(task_pathbuf: &PathBuf) -> Result<Self>

Load task YAML formatted file from the disk

pub fn save_yaml_file_to( &mut self, task_pathbuf: &PathBuf, rotate: &usize ) -> Result<()>

Save task as YAML formatted file to the disk

pub fn mark_as_completed(&mut self) -> Result<()>

Mark this task as done

pub fn new(description: String) -> Result<Self>

Create a new task with description only

pub fn to_yaml_string(&mut self) -> Result<String>

Serialize the task as YAML string

pub fn from_yaml_string(input: &str) -> Result<Self>

Deserialize the task from YAML string

pub fn from_task_descriptor(input: &String) -> Result<Self>

Create a new task from task descriptor string

Example: This is a prj:Project task that has to be done. due:2022-08-01T16:00:00 prio:low meta:x-fuu=bar tag:some tag:tags tag:can tag:be tag:added

pub fn unset_characteristic( &mut self, priority: &bool, due_date: &bool, tags: &Option<Vec<String>>, project: &bool, metadata: &Option<Vec<String>> ) -> bool

Remove task characteristics

pub fn set_characteristic( &mut self, priority: &Option<TaskPriority>, due_date: &Option<NaiveDateTime>, tags: &Option<Vec<String>>, project: &Option<String>, metadata: &Option<Vec<MetadataKeyValuePair>> ) -> bool

Set task characteristics

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<'de> Deserialize<'de> for Task

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Task

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.