Struct Task 

pub struct Task { /* private fields */ }

A task is a unit of work that can be completed by a person or a group of people. It can be assigned resources and can have a start, finish, and duration.

Implementations

impl Task

pub fn new(name: impl Into<String>) -> Self

Creates a new task with the given name.

Arguments

• name - The name of the task.

Returns

A new task with the given name.

Example

use planter_core::task::Task;

let task = Task::new("Become world leader");
assert_eq!(task.name(), "Become world leader");

pub const fn id(&self) -> Uuid

Returns the stable identifier of the task.

Example

use planter_core::task::Task;

let task = Task::new("Become world leader");
let id = task.id();

pub fn edit_start(&mut self, start: DateTime<Utc>) -> Result<()>

Edits the start time of the task. If a finish time is already set, the duration is recalculated to finish - start. If the new start time is after the finish time, the finish time is pushed ahead to match, resulting in a zero duration.

Arguments

• start - The new start time of the task.

Errors

Returns an error if the task has a finish date and the start date passed as parameter is too far from that.

Example

use chrono::Utc;
use planter_core::task::Task;

let mut task = Task::new("Become world leader");
let start_time = Utc::now();
task.edit_start(start_time).unwrap();
assert_eq!(task.start().unwrap(), start_time);

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

Returns the start time of the task. It’s None by default.

Example

use chrono::Utc;
use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert!(task.start().is_none());

let start_time = Utc::now();
task.edit_start(start_time).unwrap();
assert_eq!(task.start().unwrap(), start_time);

pub fn edit_finish(&mut self, finish: DateTime<Utc>) -> Result<()>

Edits the finish time of the task. If a start time is already set, the duration is recalculated to finish - start. If the new finish time is before the start time, the start time is pushed back to match, resulting in a zero duration.

Arguments

• finish - The new finish time of the task.

Errors

Returns an error if the task has a start date and the finish date passed as parameter is too far from that.

Example

use chrono::Utc;
use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert!(task.start().is_none());

let mut finish_time = Utc::now();
task.edit_finish(finish_time).unwrap();
assert_eq!(task.finish().unwrap(), finish_time);

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

Returns the finish time of the task. It’s None by default.

Example

use chrono::Utc;
use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert!(task.finish().is_none());
let finish_time = Utc::now();
task.edit_finish(finish_time).unwrap();
assert_eq!(task.finish().unwrap(), finish_time);

pub fn edit_duration(&mut self, duration: NonNegativeDuration)

Edits the duration of the task. If the task has a start time, finish time will be updated accordingly.

Arguments

• duration - The new duration of the task.

Example

use chrono::{Utc, Duration};
use planter_core::{task::Task, duration::NonNegativeDuration};

let mut task = Task::new("Become world leader");
task.edit_duration(Duration::minutes(30).try_into().unwrap());
assert!(task.duration().is_some());
assert_eq!(task.duration().unwrap(), Duration::minutes(30).try_into().unwrap());

pub fn add_resource(&mut self, resource: Resource)

Adds a Resource to the task.

Arguments

• resource - The resource to add to the task.

Example

use planter_core::{resources::{Resource, Material, NonConsumable}, task::Task};

let mut task = Task::new("Become world leader");
let resource = Resource::Material(Material::NonConsumable(
  NonConsumable::new("Crowbar"),
));
task.add_resource(resource);

assert_eq!(task.resources().len(), 1);

pub fn resources(&self) -> &[Resource]

Returns the list of Resource assigned to the task.

Example

use planter_core::task::Task;
use planter_core::resources::{Resource, Material, NonConsumable};

let mut task = Task::new("Become world leader");
assert!(task.resources().is_empty());
let resource = Resource::Material(Material::NonConsumable(
  NonConsumable::new("Crowbar"),
));
task.add_resource(resource);
assert_eq!(task.resources().len(), 1);

pub fn rm_resource(&mut self, index: usize) -> Option<Resource>

Removes a Resource from the task by index.

Arguments

• index - The index of the resource to remove.

Returns

The removed resource, or None if the index is out of bounds.

Example

use planter_core::{resources::{Resource, Material, NonConsumable}, task::Task};

let mut task = Task::new("Become world leader");
let resource = Resource::Material(Material::NonConsumable(
  NonConsumable::new("Crowbar"),
));
task.add_resource(resource);
assert_eq!(task.resources().len(), 1);

let removed = task.rm_resource(0);
assert!(removed.is_some());
assert_eq!(task.resources().len(), 0);

pub fn edit_name(&mut self, name: impl Into<String>)

Edits the name of the task.

Arguments

• name - The new name of the task.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
task.edit_name("Become world boss");
assert_eq!(task.name(), "Become world boss");

pub fn name(&self) -> &str

Returns the name of the task.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert_eq!(task.name(), "Become world leader");

pub fn edit_description(&mut self, description: impl Into<String>)

Edits the description of the task.

Arguments

• description - The new description of the task.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
task.edit_description("Description");
assert_eq!(task.description(), Some("Description"));

pub fn clear_description(&mut self)

Clears the description of the task, setting it to None.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
task.edit_description("Description");
assert_eq!(task.description(), Some("Description"));

task.clear_description();
assert!(task.description().is_none());

pub fn description(&self) -> Option<&str>

Returns the description of the task.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
task.edit_description("Description");
assert_eq!(task.description(), Some("Description"));

pub const fn completed(&self) -> bool

Whether the task is completed. It’s false by default.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert!(!task.completed());
task.toggle_completed();
assert!(task.completed());

pub const fn toggle_completed(&mut self)

Marks the task as completed.

Example

use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert!(!task.completed());
task.toggle_completed();
assert!(task.completed());
task.toggle_completed();
assert!(!task.completed());

pub const fn duration(&self) -> Option<NonNegativeDuration>

Returns the duration of the task. It’s None by default.

Example

use chrono::{Utc, Duration};
use planter_core::task::Task;

let mut task = Task::new("Become world leader");
assert!(task.duration().is_none());

task.edit_duration(Duration::hours(1).try_into().unwrap());
assert!(task.duration().unwrap() == Duration::hours(1).try_into().unwrap());

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a duplicate 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.