#protocols #sync #documentation #back-end #storage #taskchampion #task-champion

taskchampion-sync-server-core

Core of sync protocol for TaskChampion

1 unstable release

0.4.1 Nov 17, 2024

#96 in #sync

Download history 27/week @ 2024-11-11 89/week @ 2024-11-18

116 downloads per month
Used in taskchampion-sync-server-…

MIT license

47KB
1K SLoC

taskchampion-sync-server-core

This crate implements the core logic of the taskchampion sync protocol.

This should be considered a reference implementation, with the protocol documentation. representing the authoritative definition of the protocol. Other implementations are encouraged.


lib.rs:

This crate implements the core logic of the taskchampion sync protocol.

This should be considered a reference implementation, with the protocol documentation. representing the authoritative definition of the protocol. Other implementations are encouraged.

This crate uses an abstract storage backend. Note that this does not implement the HTTP-specific portions of the protocol, nor provide any storage implementations.

API Methods

The following API methods are implemented. These methods are documented in more detail in the protocol documentation.

Each API method takes:

  • StorageTxn to access storage. Methods which modify storage will commit the transaction before returning.
  • ServerConfig providing basic configuration for the server's behavior.
  • client_id and a Client providing the client metadata.

Dependencies

~1.6–2.1MB
~36K SLoC