saku-sync 0.4.0

Sync engine for the saku ecosystem
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

pub mod local_fs;
pub mod server;

#[cfg(feature = "server")]
pub mod server_types;

use crate::error::SyncError;

/// Trait abstracting the remote storage backend.
///
/// Phase 3 uses `LocalFsSyncBackend` (a directory on disk).
/// Phase 4 will add `ServerSyncBackend` (ureq + JWT).
pub trait SyncBackend {
    /// Fetch a file's encrypted bytes from the remote.
    fn fetch(&self, tool: &str, path: &str) -> Result<Vec<u8>, SyncError>;

    /// Push encrypted bytes to the remote.
    fn push(&self, tool: &str, path: &str, data: &[u8]) -> Result<(), SyncError>;

    /// Fetch the remote Merkle tree JSON, or `None` if it doesn't exist yet.
    fn fetch_merkle(&self) -> Result<Option<Vec<u8>>, SyncError>;

    /// Push the Merkle tree JSON to the remote.
    fn push_merkle(&self, data: &[u8]) -> Result<(), SyncError>;

    /// Check whether the backend is reachable.
    fn is_reachable(&self) -> bool;
}