chainfold 0.3.0

event-sourced chain fold engine: total order, fork recovery, durable snapshots
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

#![cfg_attr(feature = "docs", doc = include_utils::include_md!("README.md:intro"))]
#![cfg_attr(feature = "docs", doc = include_utils::include_md!("README.md:design"))]
#![cfg_attr(feature = "docs", doc = include_utils::include_md!("README.md:usage"))]
#![cfg_attr(not(test), deny(clippy::cast_possible_truncation))]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(unused_crate_dependencies)]
#![deny(warnings)]
#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(not(feature = "std"))]
#[cfg_attr(docsrs, doc(cfg(not(feature = "std"))))]
extern crate alloc;

// dev-only crates linked into the test harness build.
#[cfg(test)]
use {
    chainfold as _,
    criterion as _,
    proptest as _,
    tempfile as _,
    tokio as _,
};

// The checksum takes crc-fast on std and crc otherwise; std links the idle one unused.
#[cfg(all(feature = "std", feature = "wincode"))]
use crc as _;
#[cfg(all(feature = "std", not(feature = "wincode")))]
use crc_fast as _;

mod batch;
mod checkpoint;
mod driver;
mod engine;
mod error;
mod fold;
mod position;
mod ring;
mod sink;
mod source;

#[cfg(feature = "wincode")]
mod snapshot;

#[cfg(feature = "tokio")]
#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
pub mod harness;

#[cfg(feature = "storage")]
#[cfg_attr(docsrs, doc(cfg(feature = "storage")))]
pub mod storage;

#[cfg(any(test, feature = "test-helpers"))]
#[cfg_attr(docsrs, doc(cfg(feature = "test-helpers")))]
pub mod test_util;

pub use batch::{
    Batch,
    BatchShapeError,
    SpanView,
    Spans,
};
pub use driver::{
    Driver,
    DriverConfig,
    DriverStatus,
    Tick,
};
pub use engine::{
    ApplySummary,
    Engine,
    EngineConfig,
};
pub use error::{
    ApplyError,
    ConfigError,
    DivergenceCause,
    DurabilityLost,
    EngineStatus,
    FoldError,
    RollbackError,
};
pub use fold::Fold;
pub use position::{
    BlockRef,
    Position,
};
pub use ring::Observed;
pub use sink::{
    NoSink,
    SnapshotSink,
};
pub use source::{
    DEFAULT_WINDOW,
    ReplayHorizon,
    Source,
};

#[cfg(feature = "wincode")]
#[cfg_attr(docsrs, doc(cfg(feature = "wincode")))]
pub use snapshot::{
    Persist,
    SNAPSHOT_MAGIC,
    SNAPSHOT_VERSION,
    SnapshotError,
};