Enum StateStoreError 

pub enum StateStoreError {
    InvalidConfig(String),
    InvalidRequest(String),
    Unavailable {
        operation: String,
        message: String,
    },
    BackendOperation {
        operation: String,
        message: String,
    },
    TransactionConflict {
        operation: String,
        message: String,
    },
    TimedOut {
        operation: String,
        timeout_ms: u64,
    },
    Serialization(String),
}

Portable state-store error.

A Self::TransactionConflict establishes non-publication of that transaction. A timeout, unavailable connection, or backend finalization error does not by itself establish rollback. Reconcile durable application state before retrying a potentially committed mutation. Error messages provided by caller backends must not contain credentials or native payloads.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::transaction_conflict("commit", "concurrent write");
assert!(matches!(error, StateStoreError::TransactionConflict { .. }));

Variants

InvalidConfig(String)

Invalid configuration.

InvalidRequest(String)

Invalid caller request.

Unavailable

Backend unavailable.

Fields

operation: String

Portable operation.

message: String

Secret-safe message.

BackendOperation

Backend operation failure.

Fields

operation: String

Portable operation.

message: String

Secret-safe message.

TransactionConflict

Exact transaction conflict.

Fields

operation: String

Portable operation.

message: String

Secret-safe message.

TimedOut

Configured timeout elapsed.

Fields

operation: String

Portable operation.

timeout_ms: u64

Timeout in milliseconds.

Serialization(String)

JSON serialization failed.

Implementations

impl StateStoreError

pub fn invalid_config(message: impl Into<String>) -> Self

Creates an invalid-config error.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::invalid_config("timeout must be positive");
assert!(matches!(error, StateStoreError::InvalidConfig(_)));

pub fn invalid_request(message: impl Into<String>) -> Self

Creates an invalid-request error.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::invalid_request("key is empty");
assert!(matches!(error, StateStoreError::InvalidRequest(_)));

pub fn unavailable( operation: impl Into<String>, message: impl Into<String>, ) -> Self

Creates an unavailable error.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::unavailable("load", "connection is closed");
assert!(matches!(error, StateStoreError::Unavailable { .. }));

pub fn backend_operation( operation: impl Into<String>, message: impl Into<String>, ) -> Self

Creates a backend-operation error.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::backend_operation("load", "record could not be read");
assert!(matches!(error, StateStoreError::BackendOperation { .. }));

pub fn transaction_conflict( operation: impl Into<String>, message: impl Into<String>, ) -> Self

Creates an exact transaction-conflict error.

Use this category only when the transaction did not publish its mutations. Do not convert every concurrent timeout or transport failure into conflict.

See StateStoreError for an executable example.

pub fn timed_out(operation: impl Into<String>, timeout_ms: u64) -> Self

Creates a timeout error.

This records a deadline failure; it does not establish whether a commit admitted before the timeout eventually published.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::timed_out("commit", 500);
assert!(matches!(error, StateStoreError::TimedOut { timeout_ms: 500, .. }));

pub fn serialization(message: impl Into<String>) -> Self

Creates a serialization error.

Examples

use storage_kit::{StateStoreError};
let error = StateStoreError::serialization("invalid record encoding");
assert!(matches!(error, StateStoreError::Serialization(_)));

Trait Implementations

impl Clone for StateStoreError

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 StateStoreError

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

Formats the value using the given formatter.

impl Display for StateStoreError

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

Formats the value using the given formatter.

impl Eq for StateStoreError

impl Error for StateStoreError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for StateStoreError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl PartialEq for StateStoreError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StateStoreError