bothy 0.0.1

Serverless, local-first sync engine that uses the user's own cloud storage (Google Drive) as the transport. Early development.
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
29
30

//! # Bothy
//!
//! Bothy is a local-first sync engine for applications that have no server of their own.
//! Each device keeps its data in a local SQLite database, and devices exchange immutable,
//! append-only files through the user's own cloud storage (Google Drive first).
//!
//! **Status: early development.** This release only contains the [`Hlc`] (hybrid logical
//! clock) that orders every change in Bothy, plus the on-remote format constants. The sync
//! engine, the Drive backend and the CLI are being built at
//! <https://github.com/bothy-sync/bothy>.
//!
//! ```
//! use bothy::{Hlc, HlcClock};
//!
//! let mut clock = HlcClock::new();
//! let a = clock.now(1_700_000_000_000);
//! let b = clock.now(1_700_000_000_000); // same millisecond
//! assert!(b > a);
//! assert_eq!(b.to_hex().parse::<Hlc>().unwrap(), b);
//! ```

#![forbid(unsafe_code)]

mod hlc;

pub use hlc::{DEFAULT_MAX_DRIFT_MS, Hlc, HlcClock, ParseHlcError};

/// Version of the on-remote file format written by this crate (`bothy_format` in
/// `manifest.json`). Draft: the format is not frozen until `SPEC.md` v1.
pub const FORMAT_VERSION: u16 = 1;