Crate 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.

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.

• add_version
• get_child_version
• add_snapshot
• get_snapshot

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.

Structs

• Client
  A representation of stored metadata about a client.
• InMemoryStorage
  In-memory storage for testing and experimentation.
• ServerConfig
  ServerConfig contains configuration parameters for the server.
• Snapshot
  Metadata about a snapshot, not including the snapshot data itself.
• Version

Enums

• AddVersionResult
  Response to add_version
• GetVersionResult
  Response to get_child_version. See the protocol documentation.
• SnapshotUrgency
  Urgency of a snapshot for a client; used to create the X-Snapshot-Request header.

Constants

• NIL_VERSION_ID
  The distinguished value for “no version”

Traits

• Storage
  A trait for objects able to act as storage. Most of the interesting behavior is in the crate::storage::StorageTxn trait.
• StorageTxn
  A transaction in the storage backend.

Functions

• add_snapshot
  Implementation of the AddSnapshot protocol transaction
• add_version
  Implementation of the AddVersion protocol transaction
• get_child_version
  Implementation of the GetChildVersion protocol transaction.
• get_snapshot
  Implementation of the GetSnapshot protocol transaction

Type Aliases

• ClientId
• HistorySegment
• VersionId