harmos-runtime 0.1.4

Harmos runtime: managed state, undo, recovery, background work and typed streams.
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

/* ***
 *
 * Harmos
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * ***
 */

/* === Modules === */

pub(crate) mod capture;
mod entry {
    pub use harmos_domain::state::{
        At, CausationId, CorrelationId, Entry, Link, Metadata, Position, PrincipalId, Receipt, RequestKey, Timestamp,
    };
}
mod envelope;
mod history;
mod managed;
mod manager;
mod record;
pub(crate) mod recovery;
pub(crate) mod snapshot;
mod snapshot_codec;
mod transaction;
mod writer;

/* === Re-Exports === */

pub use crate::error::Error;
pub use capture::{CaptureError, CaptureLimits, JournalCapture};
pub use entry::{At, CausationId, CorrelationId, Entry, Link, Metadata, Position, PrincipalId, Receipt, RequestKey, Timestamp};
pub use envelope::{DefinitionId, Envelope, FactSource, Kind, Recorded, SystemFact};
pub use harmos_domain::state::{RecordDefinitions, TransactionDefinitions};
pub use history::{Focus, Origin, Reversals};
pub use managed::ManagedState;
pub use manager::StateManager;
pub(crate) use manager::{Context, Feed, TrackedState};
pub use record::{CatalogCodec, PreparationError, Prepared, Record, RecordCatalog, RecordProjection, Records};
pub use snapshot::SnapshotPolicy;
pub use transaction::{DecodeError, Invert, Never, Transaction, TransactionCatalog, Undoable};

// The proof traits generated authoring code reaches through `__private`: they
// are how a declared pair is checked mutual and how a declared inverse is
// checked to be a member of the catalog that will commit it. Public because an
// application's generated code names them, hidden because nothing else may.

pub use transaction::{Catalogued, Mutual};

// What boot needs of the journal's insides and nothing more: the fold replay
// rebuilds, the hook it re-derives inverses through, and the version table it
// dispatches stored entries by.
pub(crate) use history::{ReadRequest, Reads, ReplayPayload, Tail, Undoable as UndoEntry, Undos, replay};
pub(crate) use transaction::{Inverting, dispatch};

/* === Imports === */

// Standard Library Imports

// Third Party Imports

// Local Imports

/* === Constants === */

/* === Macros === */

/* === Type Aliases === */

/* === Structs === */

/* === Enums === */

/* === Traits === */

/* === Implementations === */

/* === Public Functions === */

/* === Private Functions === */

/* === Tests === */