GothenburgBitFactory/taskwarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskwarrior.git synced 2025-07-31 17:03:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

add docs for the 'server' and 'storage' modules

Browse source
This commit is contained in:
Dustin J. Mitchell 2021-01-10 22:02:42 -05:00
parent 02d9c577ab
commit ae4cee1ac3
2 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
taskchampion/src/server/mod.rs
View file

@ -1,3 +1,13 @@
/**
This module defines the client interface to TaskChampion sync servers.
It defines a [trait](crate::server::Server) for servers, and implements both local and remote servers.
Typical uses of this crate do not interact directly with this module; [`ServerConfig`](crate::ServerConfig) is sufficient.
However, users who wish to implement their own server interfaces can implement the traits defined here and pass the result to [`Replica`](crate::Replica).
*/
#[cfg(test)]
pub(crate) mod test;

9
taskchampion/src/storage/mod.rs
View file

@ -1,3 +1,12 @@
/**
This module defines the backend storage used by [`Replica`](crate::Replica).
It defines a [trait](crate::storage::Storage) for storage implementations, and provides a default on-disk implementation as well as an in-memory implementation for testing.
Typical uses of this crate do not interact directly with this module; [`StorageConfig`](crate::StorageConfig) is sufficient.
However, users who wish to implement their own storage backends can implement the traits defined here and pass the result to [`Replica`](crate::Replica).
*/
use failure::Fallible;
use std::collections::HashMap;
use uuid::Uuid;