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//! - [`record_index`]: exact retained record-ordinal to offset boundaries.
9//! - [`snapshot`]: snapshot wire format and restoration errors.
10//! - [`state_machine`]: the deterministic [`StreamStateMachine`] that drives a Raft group.
11//! - [`validate`]: bucket/stream id validation used by HTTP and Raft entry points.
12
13mod command;
14mod integrity;
15mod model;
16mod record_index;
17mod response;
18mod snapshot;
19mod state_machine;
20mod validate;
21
22pub use command::StreamCommand;
23pub use integrity::StreamIntegritySnapshot;
24pub use model::AppendStreamInput;
25pub use model::BucketQuota;
26pub use model::BucketQuotaSnapshot;
27pub use model::BucketUsage;
28pub use model::BucketUsageSnapshot;
29pub use model::COLD_INDEX_PAGE_SPAN_BYTES;
30pub use model::ColdChunkRef;
31pub use model::ColdFlushCandidate;
32pub use model::ColdGcEntry;
33pub use model::ColdGcTarget;
34pub use model::ExternalPayloadRef;
35pub use model::HotPayloadSegment;
36pub use model::ObjectPayloadRef;
37pub use model::ProducerAppendRecord;
38pub use model::ProducerReceipt;
39pub use model::ProducerRequest;
40pub use model::ProducerSnapshot;
41pub use model::StreamAttrs;
42pub use model::StreamBatchAppend;
43pub use model::StreamBatchAppendItem;
44pub use model::StreamBootstrapPlan;
45pub use model::StreamMessageRecord;
46pub use model::StreamMetadata;
47pub use model::StreamRead;
48pub use model::StreamReadColdIndexSegment;
49pub use model::StreamReadColdSegment;
50pub use model::StreamReadObjectSegment;
51pub use model::StreamReadPlan;
52pub use model::StreamReadSegment;
53pub use model::StreamStatus;
54pub use model::StreamVisibleSnapshot;
55pub(crate) use record_index::PreparedRecordAppend;
56pub use record_index::RecordIndexError;
57pub use record_index::StreamRecordIndex;
58pub use record_index::StreamRecordRange;
59pub use record_index::canonical_json_record_ends;
60pub use record_index::is_json_record_content_type;
61pub use response::StreamErrorCode;
62pub use response::StreamErrorContext;
63pub use response::StreamResponse;
64pub use snapshot::SharedColdObjectOwnersSnapshot;
65pub use snapshot::StreamSnapshot;
66pub use snapshot::StreamSnapshotEntry;
67pub use snapshot::StreamSnapshotError;
68pub use state_machine::COMMITTED_WRITE_UNIT_BYTES;
69pub use state_machine::StreamStateMachine;
70pub use validate::validate_bucket_id;
71pub use validate::validate_stream_id;