Crate taskchampion

This crate implements the core of TaskChampion, the replica.

Users of this crate can manipulate a task database using this API, including synchronizing that task database with others via a synchronization server.

Example uses of this crate:

• user interfaces for task management, such as mobile apps, web apps, or command-line interfaces
• integrations for task management, such as synchronization with ticket-tracking systems or request forms.

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

Replicas access the task database via a storage object. Create a storage object with StorageConfig.

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.

Feature Flags

Support for some optional functionality is controlled by feature flags.

Sync server client support:

• server-gcp - sync to Google Cloud Platform
• server-sync - sync to the taskchampion-sync-server

See Also

See the TaskChampion Book for more information about the design and usage of the tool.

Minimum Supported Rust Version (MSRV)

This crate supports Rust version 1.70.0 and higher.

Re-exports

• pub use server::Server;
• pub use server::ServerConfig;
• pub use storage::StorageConfig;
• pub use chrono;

Modules

• server
• storage

Structs

• Annotation
  An annotation for a task
• DependencyMap
  DependencyMap stores information on task dependencies between pending tasks.
• 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 descriptor for a task, that is either present or absent, and can be used for filtering. Tags composed of all uppercase letters are reserved for synthetic tags.
• Task
  A task, as publicly exposed by this crate.
• TaskMut
  A mutable task, with setter methods.
• Uuid
  Re-exported type from the uuid crate, for ease of compatibility for consumers of this crate. A Universally Unique Identifier (UUID).
• WorkingSet
  A WorkingSet represents a snapshot of the working set from a replica.

Enums

• Error
  Errors returned from taskchampion operations
• Status
  The status of a task, as defined by the task data model.

Functions

• utc_timestamp