Struct Item

pub struct Item { /* private fields */ }

An item in a todo list.

Examples

use tada::{Importance, Item};
let i = Item::parse("(A) clean my @home");
assert_eq!(Some(Importance::A), i.importance());
assert_eq!("clean my @home", i.description());
assert!(i.has_context("home"));

Implementations

impl Item

pub fn new() -> Item

pub fn parse(text: &str) -> Item

Parse an item from a line of text.

Assumes the todo.txt format.

pub fn but_done(&self, include_date: bool) -> Item

Create a version of this item but representing a completed task.

pub fn zen(&self) -> Item

Provide zen-like calm by rescheduling an overdue task.

pub fn but_pull(&self, new_urgency: Urgency) -> Item

Pull a task forward to being done with a new urgency, also clearing any start date.

pub fn fixup(&self, warnings: bool) -> Item

Performs a bunch of small fixes on the item syntax.

pub fn completion(&self) -> bool

Whether the task is complete.

pub fn set_completion(&mut self, x: bool)

Set indicator of whether the task is complete.

pub fn line_number(&self) -> usize

Line number indicator (sometimes zero).

pub fn set_line_number(&mut self, x: usize)

Set line number indicator for the task.

pub fn priority(&self) -> char

Task priority/importance as given in a todo.txt file.

A is highest, then B and C. D should be considered normal. E is low priority. Any uppercase letter is valid, but letters after E are not especially meaningful.

The importance() method is better.

pub fn set_priority(&mut self, x: char)

Set task priority.

pub fn completion_date(&self) -> Option<NaiveDate>

Completion date.

Often none.

pub fn set_completion_date(&mut self, x: NaiveDate)

Set the completion date to a given date.

pub fn clear_completion_date(&mut self)

Set the completion date to None.

pub fn creation_date(&self) -> Option<NaiveDate>

Task creation date.

Often none.

pub fn set_creation_date(&mut self, x: NaiveDate)

Set the task creation date to a given date.

pub fn clear_creation_date(&mut self)

Set the task creation date to None.

pub fn description(&self) -> String

Task description.

pub fn set_description(&mut self, x: String)

Set the task description.

Internally clears cached tags, etc.

pub fn importance(&self) -> Option<Importance>

Return the importance of this task.

Basically the same as priority, except it’s an enum and all letters after E are treated as being the same as E.

pub fn set_importance(&mut self, i: Importance)

Set the item’s importance.

pub fn clear_importance(&mut self)

Set the item’s importance.

pub fn due_date(&self) -> Option<NaiveDate>

Return the date when this task is due by.

pub fn start_date(&self) -> Option<NaiveDate>

Return the date when this task may be started.

pub fn is_startable(&self) -> bool

A task is startable if it doesn’t have a start date which is in the future.

pub fn urgency(&self) -> Option<Urgency>

Classify how urgent this task is.

pub fn set_urgency(&mut self, urg: Urgency)

Set task urgency.

pub fn tshirt_size(&self) -> Option<TshirtSize>

Return the size of this task.

pub fn tags(&self) -> Vec<String>

Tags.

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

Boolean indicating whether a task has a particular tag.

pub fn contexts(&self) -> Vec<String>

Contexts.

pub fn has_context(&self, ctx: &str) -> bool

Boolean indicating whether a task has a particular context.

pub fn kv(&self) -> HashMap<String, String>

Key-Value Tags.

pub fn smart_key(&self) -> (Urgency, Importance, TshirtSize)

Key used for smart sorting

Trait Implementations

impl Clone for Item

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Debugging output; used for format!(“{:?}”)

impl Default for Item

fn default() -> Self

Returns the “default value” for a type.

impl Display for Item

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

File-ready output; used for format!(“{}”)