taskchampion

Crates.iotaskchampion
lib.rstaskchampion
version0.5.0
sourcesrc
created_at2020-11-30 02:11:55.917356
updated_at2024-04-22 01:49:37.622434
descriptionPersonal task-tracking
homepagehttps://gothenburgbitfactory.github.io/taskwarrior/taskchampion/
repositoryhttps://github.com/GothenburgBitFactory/taskwarrior
max_upload_size
id318061
size305,912
Dustin J. Mitchell (djmitche)

documentation

https://docs.rs/crate/taskchampion

README

TaskChampion

TaskChampion implements the task storage and synchronization behind Taskwarrior. It includes an implementation with Rust and C APIs, allowing any application to maintain and manipulate its own replica. It also includes a specification for tasks and how they are synchronized, inviting alternative implementations of replicas or task servers.

See the documentation for more!

Structure

There are four crates here:

  • taskchampion - the core of the tool
  • taskchampion-lib - glue code to use taskchampion from C
  • integration-tests (private) - integration tests covering taskchampion and taskchampion-lib.
  • xtask (private) - implementation of the cargo xtask codegen command

Code Generation

The taskchampion_lib crate uses a bit of code generation to create the lib/taskchampion.h header file. To regenerate this file, run cargo xtask codegen.

Rust API

The Rust API, as defined in the docs, supports simple creation and manipulation of replicas and the tasks they contain.

The Rust API follows semantic versioning. As this is still in the 0.x phase, so breaking changes may occur but will be indicated with a change to the minor version.

C API

The taskchampion-lib crate generates libraries suitable for use from C (or any C-compatible language). It is a "normal" Cargo crate that happens to export a number of extern "C" symbols, and also contains a taskchampion.h defining those symbols.

WARNING: the C API is not yet stable!

It is your responsibility to link this into a form usable in your own build process. For example, in a typical CMake C++ project, CMakeRust can do this for you. In many cases, this is as simple as a rust crate with src/lib.rs containing

pub use taskchampion_lib::*;

Arrange to use the header file, lib/taskchampion.h, by copying it or adding its directory to your include search path. Future work will provide better automation for this process.

Commit count: 11642

cargo fmt