SledStateBackend

Struct SledStateBackend 

Source
pub struct SledStateBackend { /* private fields */ }
Expand description

Sled-based persistent state backend

This backend uses the Sled embedded database for persistent state storage. It’s designed for production use where state must survive process restarts.

§Features

  • Persistent: State survives restarts
  • ACID: Atomic operations with durability guarantees
  • Efficient: Lock-free data structures and zero-copy operations
  • Compression: Optional compression to save disk space
  • Crash recovery: Automatic recovery from crashes

§Example

use processor::state::{SledStateBackend, SledConfig, StateBackend};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Create configuration with best compression
    let config = SledConfig::new("/var/lib/optimizer/state")
        .with_cache_capacity(256 * 1024 * 1024) // 256MB
        .with_best_compression(); // Use Zstd for maximum compression

    // Open database
    let backend = SledStateBackend::open(config).await?;

    // Use like any other backend
    backend.put(b"window:123", b"aggregated_data").await?;

    // Data persists across restarts
    backend.flush().await?;

    Ok(())
}

Implementations§

Source§

impl SledStateBackend

Source

pub async fn open(config: SledConfig) -> StateResult<Self>

Open a Sled database with the given configuration

§Arguments
  • config - Database configuration
§Returns
  • Ok(SledStateBackend) - Successfully opened database
  • Err(StateError) - Failed to open database
§Example
let config = SledConfig::new("/tmp/test_db");
let backend = SledStateBackend::open(config).await?;
Source

pub async fn temporary() -> StateResult<Self>

Create a temporary Sled backend for testing

This creates a database in a temporary directory that will be cleaned up when the backend is dropped.

§Returns

A new temporary Sled backend

§Example
let backend = SledStateBackend::temporary().await?;
// Use for testing...
Source

pub async fn flush(&self) -> StateResult<usize>

Flush all pending writes to disk

This ensures that all writes are persisted to disk. It’s called automatically after every N operations (configured by flush_every), but can also be called manually for critical checkpoints.

§Returns
  • Ok(usize) - Number of bytes flushed
  • Err(StateError) - Flush failed
§Example
backend.put(b"important", b"data").await?;
let flushed = backend.flush().await?;
println!("Flushed {} bytes", flushed);
Source

pub async fn stats(&self) -> SledBackendStats

Get database statistics

§Returns

Current backend statistics

Source

pub async fn compression_ratio(&self) -> Option<f64>

Get compression ratio as a percentage

§Returns

Compression ratio (0.0-100.0), or None if no data has been compressed yet

§Example

A ratio of 30.0 means compressed data is 30% of the original size

Source

pub async fn space_saved(&self) -> u64

Get total space saved by compression in bytes

§Returns

Number of bytes saved by compression

Source

pub async fn size_on_disk(&self) -> StateResult<u64>

Get the size of the database on disk in bytes

§Returns

Database size in bytes

Source

pub async fn checkpoint(&self) -> StateResult<Vec<(Vec<u8>, Vec<u8>)>>

Create a checkpoint of the current database state

This exports all key-value pairs for backup or migration.

§Returns

Vector of (key, value) pairs

Source

pub async fn restore( &self, checkpoint: Vec<(Vec<u8>, Vec<u8>)>, ) -> StateResult<()>

Restore from a checkpoint

This clears the current database and restores from the provided checkpoint.

§Arguments
  • checkpoint - Vector of (key, value) pairs to restore
§Returns
  • Ok(()) - Restore successful
  • Err(StateError) - Restore failed

Trait Implementations§

Source§

impl Drop for SledStateBackend

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl StateBackend for SledStateBackend

Source§

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = StateResult<Option<Vec<u8>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a value for the given key Read more
Source§

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 [u8], value: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = StateResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Store a value for the given key Read more
Source§

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = StateResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a key and its associated value Read more
Source§

fn list_keys<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = StateResult<Vec<Vec<u8>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List all keys with the given prefix Read more
Source§

fn clear<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StateResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Clear all state from the backend Read more
Source§

fn count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StateResult<usize>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get the number of keys in the backend Read more
Source§

fn contains<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = StateResult<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if a key exists Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more