pub struct SegmentBuffer<T> { /* private fields */ }Expand description
Durable bounded queue of T backed by compressed segment files.
Thread-safe via parking_lot::Mutex. All file I/O is synchronous. The mutex
is never held across an async boundary because there are no await points.
Create with SegmentBuffer::open, supplying the directory and config.
Implementations§
Source§impl<T> SegmentBuffer<T>
impl<T> SegmentBuffer<T>
Sourcepub fn open(dir: impl Into<PathBuf>, config: SegmentConfig) -> Result<Self>
pub fn open(dir: impl Into<PathBuf>, config: SegmentConfig) -> Result<Self>
Open (or create) a buffer at dir, recovering from any existing
segment files.
Recovery is filename-based: it scans the directory to rebuild
head_seq / next_seq and deletes leftover .tmp debris. Segment
contents are not read until read_from, so a
corrupted segment does not fail here — it fails when read.
§Errors
Returns SegmentError::Io if the directory cannot be created or read.
Sourcepub fn append(&self, event: T) -> Result<u64>
pub fn append(&self, event: T) -> Result<u64>
Append an item to the buffer. Assigns the next sequence number and auto-flushes if the batch threshold or interval is reached.
Returns the assigned sequence number.
Sourcepub fn flush(&self) -> Result<()>
pub fn flush(&self) -> Result<()>
Flush buffered items to a segment file. No-op if nothing is buffered.
Sourcepub fn read_from(&self, start_seq: u64, limit: usize) -> Result<Vec<T>>
pub fn read_from(&self, start_seq: u64, limit: usize) -> Result<Vec<T>>
Read up to limit items starting from start_seq (inclusive).
Reads from both on-disk segment files and in-memory pending items. Items are returned in ascending sequence order.
Sourcepub fn delete_acked(&self, acked_seq: u64) -> Result<usize>
pub fn delete_acked(&self, acked_seq: u64) -> Result<usize>
Delete all on-disk segment files whose items are fully covered by
acked_seq.
A segment is deleted when its end_seq <= acked_seq. Returns the number
of segment files removed.
§Limitation
Acknowledgement only removes flushed segment files. Items still held
in the in-memory pending batch have no segment file to delete, so they
remain readable (and counted by SegmentBuffer::pending_count) until
they are flushed and acknowledged in a later call. head_seq is clamped
so it never advances past the pending window, keeping the backlog count
honest.
Sourcepub fn latest_sequence(&self) -> u64
pub fn latest_sequence(&self) -> u64
The highest sequence number assigned (or 0 if buffer is empty).
Sourcepub fn pending_count(&self) -> u64
pub fn pending_count(&self) -> u64
Total items waiting in the buffer (on-disk + in-memory pending).
Sourcepub fn store_pressure(&self) -> f32
pub fn store_pressure(&self) -> f32
Disk usage pressure as a value between 0.0 and 1.0.
Use this to implement your own admission/backpressure policy (e.g. reject low-priority items above 0.90, reject standard items above 0.95).
Sourcepub fn is_overloaded(&self) -> bool
pub fn is_overloaded(&self) -> bool
True when disk usage exceeds 90% of the configured limit.