pulsify-sqlite 6.0.0

Pulsify SQLite patch store and frame relay, file-compatible with the TypeScript SqlitePatchStore
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Durable Pulsify documents in SQLite, without materializing them.
//!
//! The database file uses the schema and append semantics of the TypeScript
//! `SqlitePatchStore`, so either implementation can open a file written by the other.
mod hub;
mod relay;
mod store;

pub use hub::{Hub, Sink};
pub use pulsify_protocol::{PatchRow, VersionVector};
pub use relay::{chunk_rows, relay_frame, RelayOutput};
pub use store::{validate_doc_id, AppendResult, SqliteStore, SCHEMA};

use std::fmt;

/// A failure carrying a Pulsify protocol error code, such as `CONFLICT`.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Error {
    pub code: &'static str,
    pub message: String,
}
impl Error {
    pub fn new(code: &'static str, message: impl Into<String>) -> Self {
        Self {
            code,
            message: message.into(),
        }
    }
}
impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}: {}", self.code, self.message)
    }
}
impl std::error::Error for Error {}
impl From<pulsify_protocol::Error> for Error {
    fn from(error: pulsify_protocol::Error) -> Self {
        Self::new(error.code, error.message)
    }
}
impl From<rusqlite::Error> for Error {
    fn from(error: rusqlite::Error) -> Self {
        Self::new("CONNECTION_FAILED", format!("SQLite: {error}"))
    }
}
impl From<serde_json::Error> for Error {
    fn from(error: serde_json::Error) -> Self {
        Self::new(
            "CONNECTION_FAILED",
            format!("Corrupt stored metadata: {error}"),
        )
    }
}
pub type Result<T> = std::result::Result<T, Error>;