Enum StateBackendConfig 

pub enum StateBackendConfig {
    InProcess,
    Local {
        path: PathBuf,
    },
    ObjectStore {
        url: String,
        storage: StorageOptions,
    },
}

Tagged-union config that selects checkpoint-artifact storage.

Variants

InProcess

Non-durable in-process backend. The default.

Local

Durable single-node backend on a local filesystem path. Shorthand for an object_store backend with a file:// URL.

Fields

path: PathBuf

Filesystem root for state.

ObjectStore

Object-store backend. Cloud URLs (s3://, gs://, az://) are cluster-shared; file:// is node-durable only.

Fields

url: String

Object store URL: s3://bucket/prefix, gs://bucket/prefix, etc.

storage: StorageOptions

Cloud credentials/config overrides (e.g. endpoint, aws_access_key_id), same keys as [checkpoint.storage]. Anything absent falls back to the provider’s standard env vars (AWS_ACCESS_KEY_ID, …).

Implementations

impl StateBackendConfig

pub fn in_process() -> Self

Builder: embedded library, single process.

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

Builder: single-node durable state on the local filesystem.

pub fn object_store(url: impl Into<String>) -> Self

Builder: object-store-backed state for an embedded or single-node runtime. Credentials resolve from the provider’s standard env vars; use the storage config field for explicit overrides.

pub fn build( &self, key_groups: KeyGroupCount, ) -> Result<Arc<dyn StateBackend>, StateBackendBuildError>

Instantiate the runtime backend.

Errors

• StateBackendBuildError::Store for a bad URL, a scheme whose feature flag (aws/gcs/azure) is not compiled in, or cloud-client construction failure.
• StateBackendBuildError::Io on filesystem setup.

pub fn local_storage_dir(&self) -> Option<&Path>

Filesystem path for durable state, if any. Returns None for non-filesystem backends.

pub fn build_object_store( &self, ) -> Result<Option<Arc<dyn ObjectStore>>, StateBackendBuildError>

Build the underlying object_store handle (if any) so callers that need to share the same store — e.g. an AssignmentSnapshotStore alongside the state backend — can avoid re-parsing the URL. None for InProcess.

Errors

Same failure modes as Self::build.

pub fn durability_scope(&self) -> StateBackendDurability

Failure scope survived by the configured backend.

A local path and file:// survive a same-node process restart but do not claim peer visibility. Supported cloud schemes name a shared service and therefore satisfy cluster recovery admission.

Trait Implementations

impl Clone for StateBackendConfig

fn clone(&self) -> StateBackendConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateBackendConfig

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

Formats the value using the given formatter.

impl Default for StateBackendConfig

fn default() -> StateBackendConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateBackendConfig

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StateBackendConfig

impl PartialEq for StateBackendConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StateBackendConfig