[−][src]Crate taskchampion
This crate implements the core of TaskChampion, the replica.
Replica
A TaskChampion replica is a local copy of a user's task data. As the name suggests, several replicas of the same data can exist (such as on a user's laptop and on their phone) and can synchronize with one another.
Replicas are accessed using the Replica
type.
Task Storage
The storage
module supports pluggable storage for a replica's data.
An implementation is provided, but users of this crate can provide their own implementation as well.
Server
Replica synchronization takes place against a server.
Create a server with ServerConfig
.
The server
module defines the interface a server must meet.
Users can define their own server impelementations.
See Also
See the TaskChampion Book for more information about the design and usage of the tool.
Modules
server | |
storage |
Structs
Replica | A replica represents an instance of a user's task data, providing an easy interface for querying and modifying that data. |
Tag | A Tag is a newtype around a String that limits its values to valid tags. |
Task | A task, as publicly exposed by this crate. |
TaskMut | A mutable task, with setter methods. Most methods are simple setters and not further described. Calling a setter will update the Replica, as well as the included Task. |
Uuid | Re-exported type from the |
WorkingSet | A WorkingSet represents a snapshot of the working set from a replica. |
Enums
Priority | The priority of a task |
ServerConfig | The configuration for a replica's access to a sync server. |
Status | The status of a task. The default status in "Pending". |
StorageConfig | The configuration required for a replica's storage. |
Traits
Server | A value implementing this trait can act as a server against which a replica can sync. |