harmos-storage 0.1.6

Harmos storage: durable journals, snapshots and Arrow-backed stream storage.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

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

/* === Modules === */

mod admissions;

pub mod aggregate;
pub mod arrow;
mod backend;
mod batch;
mod batching;
mod capacity;
pub mod config;
mod deletion;
pub mod directory;
mod error;
pub mod execution;
mod file_batch;
mod file_capture;
mod file_checkpoint;
mod file_follow;
mod file_hash;
mod file_production;
mod file_reads;
pub mod follow;
pub mod json;
mod local;
mod manager;
mod memory;
mod object_admissions;
mod objects;
pub mod query;
mod queue;
mod read_batch;
mod read_session;
mod receipts;
mod schema_encoding;
mod selection;
pub mod signal;
mod snapshot;
mod staging;
pub mod state;
mod worker;
pub mod writes;

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

pub use backend::{BackendSnapshot, ReadLimits, ScanPage, StorageBackend, StorageBackends, StorageFuture};
pub use batch::{FileChunk, StorageBatch};
pub use config::{StorageBudget, StorageFilesystemSettings, StorageRequestSettings, StorageResponseSettings, StorageSettings};
pub use directory::{DirectoryReader, DirectoryWatcher};
pub use error::{BackendFailure, Error, Result};
pub use file_batch::{FileReadBatch, FileReadEvent, FileReadSlice};
pub use file_checkpoint::FileCheckpoint;
pub use file_follow::FileFollower;
pub use file_production::ProductionFollower;
pub use file_reads::FileReader;
pub use harmos_domain::model::storage::files;
pub use harmos_domain::model::storage::{
    ByteRange, CaptureConsistency, FileBatch, FileCompletion, FileEvent, FileHash, FileMetadata, FilePhase, FileProducer, FileProgress,
    FileReference, FileSession, FileSource, FollowStart, IdentityKind, IdentitySelection, MutationId, MutationWindow, ObjectCatalog,
    ObjectDefinition, ObjectDefinitions, ObjectEntry, ObjectKey, ObjectPoint, ObjectReceipt, ObjectRetention, ObjectRevision, ObjectValue,
    ObjectVersion, ObjectVersionToken, PayloadEncoding, RecordInput, RecordWrite, RecoveryPosition, SchemaInfo, SchemaInput, SchemaKey,
    StagedFile, StorageCursor, StorageInfo, StoreHistory, StoredIdentity, StoredObject, StoredRecord, StoredRow, StreamInput, StreamWrite,
};
pub use json::{JsonStorage, JsonStorageSettings};
pub use manager::{ErasedCatalog, StorageManager, StorageMetrics, WorkerOwner, encoded_size};
pub use objects::ObjectGroup;
pub use query::{ObjectRead, ObjectReader, QueryReader, RecordRead, RecordReader};
pub use read_batch::{ReadBatch, ReadPages};
pub use read_session::ReadSession;
pub use receipts::{MutationReceipt, MutationValue};
pub use staging::StorageFile;

pub use harmos_domain::{Aggregate, Identifier, MemorySize, Message, btree_map_memory, schema};
pub use staging::checkpoint::FileSave;
pub use worker::Worker;
pub use writes::StorageSchema;

/* === Imports === */

// Standard Library Imports

// Third Party Imports
extern crate self as harmos_storage;

// Local Imports
// Internal Paths Refer To This Crate's One Canonical Engine Namespace.
use crate as storage;

/* === Constants === */

/* === Macros === */

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

/* === Structs === */

/* === Enums === */

/* === Traits === */

/* === Implementations === */

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

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

/* === Tests === */

#[cfg(test)]
#[allow(dead_code, reason = "capacity invariants use the shared in-memory storage backends")]
#[path = "../tests/support/storage.rs"]
mod test_backend;