Struct Task

pub struct Task {
    pub id: String,
    pub title: String,
    pub context: String,
    pub created_date: DateTime<Local>,
    pub priority: i64,
    pub notes: Vec<Note>,
    pub completed_date: Option<DateTime<Local>>,
    pub body: Option<String>,
}

Task is the primary data object in taskforge everything works on or around Tasks. All tasks have an id field which is a unique identifier generated as a BSON ObjectID converted to a hex string.

All fields of a task are public however you should not generally change the id of an existing Task.

All tasks implement Serialize and Deserialize from serde.

Additionally Tasks implement Eq, PartialEq, and Ord so given a container of tasks that allows for sorting one can sort the Tasks by priority descending followed by oldest created date first.

Fields

id: String

title: String

context: String

created_date: DateTime<Local>

priority: i64

notes: Vec<Note>

completed_date: Option<DateTime<Local>>

body: Option<String>

Implementations

impl Task

pub fn new(title: &str) -> Task

Create a new Task with title.

This function will auto generate a BSON ObjectID as well as set other fields to their default values.

The Default values are as follows:

Field	Type	Default Value
id	String	BSON ObjectID
context	String	"default"
created_date	Chrono::DateTime<Local>	current local time created with Chrono::Local::now()
completed_date	Option<Chrono::DateTime<Local>>	None
priority	f64	1.0
notes	Vec<Note>	[]
body	String	""

pub fn with_context(self, context: &str) -> Task

Change the context of a task during creation using the builder pattern.

pub fn with_priority(self, priority: i64) -> Task

Change the priority of a task during creation using the builder pattern.

pub fn with_body(self, body: &str) -> Task

Change the body of a task during creation using the builder pattern.

pub fn precomplete(self) -> Task

Complete a task during creation using the builder pattern.

pub fn complete(&mut self)

Complete this task

pub fn completed(&self) -> bool

Returns a boolean indicating whether this task is completed or not.

pub fn add_note(&mut self, message: &str)

Add a note to the task with message

pub fn to_json(&self) -> Result<String, Error>

Serialize this task to JSON

pub fn update(&mut self, other: Task)

Update this task with all fields from other except for self.id

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 Display for Task

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

Formats the value using the given formatter.

impl Ord for Task

fn cmp(&self, other: &Task) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Task

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Task

fn partial_cmp(&self, other: &Task) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

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.

impl Eq for Task

impl StructuralPartialEq for Task