Struct TaskData

pub struct TaskData { /* private fields */ }

A task.

This type presents a low-level interface consisting only of a key/value map. Interpretation of fields is up to the user, and modifications both modify the TaskData and create one or more Operation values that can later be committed to the replica.

This interface is intended for sophisticated applications like Taskwarrior which give meaning to key and values themselves. Use Task for a higher-level interface with methods to update status, set tags, and so on.

Implementations

impl TaskData

pub fn create(uuid: Uuid, operations: &mut Operations) -> Self

Create a new, empty task with the given UUID.

pub fn get_uuid(&self) -> Uuid

Get this task’s UUID.

pub fn get(&self, property: impl AsRef<str>) -> Option<&str>

Get a value on this task.

pub fn has(&self, property: impl AsRef<str>) -> bool

Check if the given property is set.

pub fn properties(&self) -> impl Iterator<Item = &String>

Enumerate all properties on this task, in arbitrary order.

pub fn iter(&self) -> impl Iterator<Item = (&String, &String)>

Enumerate all properties and their values on this task, in arbitrary order.

pub fn update( &mut self, property: impl Into<String>, value: Option<String>, operations: &mut Operations, )

Set or remove a value on this task, adding an Update operation to the set of operations.

Setting a value to None removes that value from the task.

This method does not have any special handling of the modified property.

pub fn delete(&mut self, operations: &mut Operations)

Delete this task.

Note that this is different from setting status to Deleted: the resulting operation removes the task from the database.

Deletion may interact poorly with modifications to the same task on other replicas. For example, if a task is deleted on replica 1 and its description modified on replica 2, then after both replicas have fully synced, the resulting task will only have a description property.

After this call, the TaskData value still exists but has no properties and should be dropped.

Trait Implementations

impl Clone for TaskData

fn clone(&self) -> TaskData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskData

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

Formats the value using the given formatter.

impl PartialEq for TaskData

fn eq(&self, other: &TaskData) -> 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 Eq for TaskData

impl StructuralPartialEq for TaskData