Skip to main content

ursula_stream/
lib.rs

1//! Durable Streams state machine for Ursula.
2//!
3//! Module map:
4//!
5//! - [`command`]: replicated command variants applied to the state machine.
6//! - [`response`]: result variants and error codes returned per command.
7//! - [`model`]: persistent data types (metadata, segments, producer state, plans).
8//! - [`snapshot`]: snapshot wire format and restoration errors.
9//! - [`state_machine`]: the deterministic [`StreamStateMachine`] that drives a Raft group.
10//! - [`validate`]: bucket/stream id validation used by HTTP and Raft entry points.
11
12mod command;
13mod integrity;
14mod model;
15mod response;
16mod snapshot;
17mod state_machine;
18mod validate;
19
20pub use command::StreamCommand;
21pub use integrity::StreamIntegritySnapshot;
22pub use model::AppendStreamInput;
23pub use model::COLD_INDEX_PAGE_SPAN_BYTES;
24pub use model::ColdChunkRef;
25pub use model::ColdFlushCandidate;
26pub use model::ColdGcEntry;
27pub use model::ColdGcTarget;
28pub use model::ExternalPayloadRef;
29pub use model::HotPayloadSegment;
30pub use model::ObjectPayloadRef;
31pub use model::ProducerAppendRecord;
32pub use model::ProducerRequest;
33pub use model::ProducerSnapshot;
34pub use model::StreamAttrs;
35pub use model::StreamBatchAppend;
36pub use model::StreamBatchAppendItem;
37pub use model::StreamBootstrapPlan;
38pub use model::StreamMessageRecord;
39pub use model::StreamMetadata;
40pub use model::StreamRead;
41pub use model::StreamReadColdIndexSegment;
42pub use model::StreamReadColdSegment;
43pub use model::StreamReadObjectSegment;
44pub use model::StreamReadPlan;
45pub use model::StreamReadSegment;
46pub use model::StreamStatus;
47pub use model::StreamVisibleSnapshot;
48pub use response::StreamErrorCode;
49pub use response::StreamErrorContext;
50pub use response::StreamResponse;
51pub use snapshot::StreamSnapshot;
52pub use snapshot::StreamSnapshotEntry;
53pub use snapshot::StreamSnapshotError;
54pub use state_machine::StreamStateMachine;
55pub use validate::validate_bucket_id;
56pub use validate::validate_stream_id;