Skip to main content

MemoryStateBackend

Struct MemoryStateBackend 

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

In-memory state backend using DashMap

This backend stores all state in memory using a concurrent hash map (DashMap). It’s ideal for:

  • Testing: Fast, no external dependencies
  • Stateless processing: When state doesn’t need to survive restarts
  • Small state: When state fits comfortably in memory
  • High throughput: Fastest possible state access

§Features

  • Thread-safe: Uses DashMap for lock-free concurrent access
  • TTL support: Automatic expiration of old entries
  • Statistics: Tracks access patterns and cache hit rates
  • Checkpoint/Restore: Can snapshot state to disk

§Example

use processor::state::{MemoryStateBackend, StateBackend};
use std::time::Duration;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Create backend with 1-hour TTL
    let backend = MemoryStateBackend::new(Some(Duration::from_secs(3600)));

    // Store state
    backend.put(b"session:123", b"user_data").await?;

    // Retrieve state
    if let Some(data) = backend.get(b"session:123").await? {
        println!("Session data: {:?}", data);
    }

    // Get statistics
    let stats = backend.stats().await;
    println!("Hit rate: {:.2}%",
        100.0 * stats.hit_count as f64 / (stats.hit_count + stats.miss_count) as f64);

    Ok(())
}

Implementations§

Source§

impl MemoryStateBackend

Source

pub fn new(ttl: Option<Duration>) -> Self

Create a new in-memory state backend

§Arguments
  • ttl - Optional time-to-live for entries. If None, entries never expire.
§Returns

A new MemoryStateBackend instance

§Example
use processor::state::MemoryStateBackend;
use std::time::Duration;

// No TTL - entries never expire
let backend1 = MemoryStateBackend::new(None);

// 1 hour TTL
let backend2 = MemoryStateBackend::new(Some(Duration::from_secs(3600)));
Source

pub async fn stats(&self) -> MemoryBackendStats

Get current statistics

§Returns

A snapshot of current backend statistics

Source

pub async fn cleanup_expired(&self) -> usize

Clean up expired entries

This method scans all entries and removes those that have exceeded the TTL. Returns the number of entries removed.

§Returns

Number of entries removed

§Example
let backend = MemoryStateBackend::new(Some(Duration::from_secs(60)));

// Periodically clean up expired entries
let removed = backend.cleanup_expired().await;
println!("Removed {} expired entries", removed);
Source

pub fn start_cleanup_task(&self, interval: Duration) -> JoinHandle<()> ⓘ

Start automatic cleanup background task

Spawns a background task that periodically cleans up expired entries.

§Arguments
  • interval - How often to run cleanup
§Returns

A handle that cancels the cleanup task when dropped

§Example
let backend = MemoryStateBackend::new(Some(Duration::from_secs(3600)));

// Clean up every 5 minutes
let _cleanup_handle = backend.start_cleanup_task(Duration::from_secs(300));

// Cleanup runs in background...
Source

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

Create a checkpoint of current state

Returns all key-value pairs as a vector for serialization.

§Returns

Vector of (key, value) pairs

Source

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

Restore state from a checkpoint

Replaces all current state with the provided checkpoint data.

§Arguments
  • checkpoint - Vector of (key, value) pairs to restore
Source

pub async fn memory_usage(&self) -> usize

Get total memory usage in bytes (approximate)

§Returns

Approximate memory usage in bytes

Trait Implementations§

Source§

impl Clone for MemoryStateBackend

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl StateBackend for MemoryStateBackend

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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