pub struct LogPayloadStorage { /* private fields */ }Expand description
Log-structured payload storage with snapshot support.
Stores payloads in an append-only log file with an in-memory index. Supports periodic snapshots for O(1) cold-start recovery instead of O(N) WAL replay.
Implementations§
Source§impl LogPayloadStorage
impl LogPayloadStorage
Sourcepub fn new<P: AsRef<Path>>(path: P) -> Result<Self>
pub fn new<P: AsRef<Path>>(path: P) -> Result<Self>
Creates a new LogPayloadStorage with the default durability mode (Fsync).
If a snapshot file exists and is valid, loads from snapshot and replays only the WAL delta for fast startup. Otherwise, falls back to full WAL replay.
§Errors
Returns an error if file operations fail.
Sourcepub fn new_with_durability<P: AsRef<Path>>(
path: P,
durability: DurabilityMode,
) -> Result<Self>
pub fn new_with_durability<P: AsRef<Path>>( path: P, durability: DurabilityMode, ) -> Result<Self>
Creates a new LogPayloadStorage with the specified durability mode.
See DurabilityMode for available modes and their trade-offs.
§Errors
Returns an error if file operations fail.
Sourcepub fn create_snapshot(&mut self) -> Result<()>
pub fn create_snapshot(&mut self) -> Result<()>
Creates a snapshot of the current index state.
The snapshot captures:
- Current WAL position
- All index entries (ID -> offset mappings)
- CRC32 checksum for integrity
§Errors
Returns an error if file operations fail.
Sourcepub fn should_create_snapshot(&self) -> bool
pub fn should_create_snapshot(&self) -> bool
Returns whether a new snapshot should be created.
Heuristic: Returns true if WAL has grown by more than the default threshold bytes since the last snapshot.
Sourcepub fn store_batch(&mut self, entries: &[(u64, &Value)]) -> Result<()>
pub fn store_batch(&mut self, entries: &[(u64, &Value)]) -> Result<()>
Stores multiple payloads in a single batch operation.
Optimized for bulk imports: acquires WAL + index + offset locks once, writes all records sequentially, and performs a single durability sync at the end instead of per-point fsync.
§Errors
Returns an error if serialization or WAL write fails. On partial failure, entries written before the error are durable (WAL is append-only).
Sourcepub fn store_batch_deferred(&mut self, entries: &[(u64, &Value)]) -> Result<()>
pub fn store_batch_deferred(&mut self, entries: &[(u64, &Value)]) -> Result<()>
Stores multiple payloads without forcing an fsync at the end.
Identical to store_batch except the final
sync_all() is replaced by a buffer-only flush(). WAL entries are
written and the BufWriter is flushed to the OS kernel, but not
fsynced to disk.
Use this for intermediate batches in a streaming bulk import, where
only the final batch needs full durability. Call
PayloadStorage::flush() after the last batch to force fsync.
§Errors
Returns an error if serialization or WAL write fails.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for LogPayloadStorage
impl !RefUnwindSafe for LogPayloadStorage
impl Send for LogPayloadStorage
impl Sync for LogPayloadStorage
impl Unpin for LogPayloadStorage
impl UnsafeUnpin for LogPayloadStorage
impl UnwindSafe for LogPayloadStorage
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);