Struct RedbStateStoreConfig 

pub struct RedbStateStoreConfig { /* private fields */ }

Redb embedded StateStore configuration.

This always-available config selects the Redb StateStore backend, which requires the redb feature. Use Self::memory for process-local embedded state and Self::file for persisted embedded state.

Examples

let config = storage_kit::state::config::RedbStateStoreConfig::memory();
let state_config = storage_kit::state::config::StateStoreConfig::redb(config);
let _ = state_config;

Implementations

impl RedbStateStoreConfig

pub fn memory() -> Self

Builds an in-memory Redb StateStore config.

Examples

let config = storage_kit::state::config::RedbStateStoreConfig::memory();
if !config.location().is_memory() {
    return Err(storage_kit::StateStoreError::InvalidRequest(
        "expected memory location".to_owned(),
    ));
}

pub fn file(path: impl Into<PathBuf>) -> Self

Builds a file-backed Redb StateStore config.

Examples

let path = std::env::temp_dir().join("storage-kit-state.redb");
let config = storage_kit::state::config::RedbStateStoreConfig::file(path);
let _ = config;

pub fn with_operation_timeout( self, timeout: Duration, ) -> Result<Self, StateStoreError>

Replaces the operation timeout.

Errors

Returns an invalid-config error when the timeout is zero or cannot be represented as milliseconds.

Examples

let config = storage_kit::state::config::RedbStateStoreConfig::memory()
    .with_operation_timeout(std::time::Duration::from_secs(2))?;
let _ = config;

pub fn with_cache_size_bytes(self, bytes: usize) -> Self

Replaces the Redb cache size in bytes.

Examples

let config = storage_kit::state::config::RedbStateStoreConfig::memory()
    .with_cache_size_bytes(64 * 1024 * 1024);
let _ = config;

pub fn operation_timeout(&self) -> Duration

Returns the configured operation timeout.

Examples

let timeout = storage_kit::state::config::RedbStateStoreConfig::memory().operation_timeout();
let _ = timeout;

pub fn cache_size_bytes(&self) -> usize

Returns the configured Redb cache size in bytes.

Examples

let bytes = storage_kit::state::config::RedbStateStoreConfig::memory().cache_size_bytes();
let _ = bytes;

pub fn location(&self) -> &RedbStateStoreLocation

Returns the configured Redb location.

Examples

let config = storage_kit::state::config::RedbStateStoreConfig::memory();
let location = config.location();
let _ = location;

pub fn validate(&self) -> Result<(), StateStoreError>

Validates Redb location, timeout, and cache settings.

Errors

Returns an invalid-config error when a numeric setting is zero or a file path is not valid for Redb construction.

Examples

storage_kit::state::config::RedbStateStoreConfig::memory().validate()?;

Trait Implementations

impl Clone for RedbStateStoreConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedbStateStoreConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RedbStateStoreConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RedbStateStoreConfig

impl From<RedbStateStoreConfig> for StateStoreConfig

fn from(config: RedbStateStoreConfig) -> Self

Converts to this type from the input type.

impl PartialEq for RedbStateStoreConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RedbStateStoreConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.