Enum ReplicationError 

pub enum ReplicationError {
    Redis {
        operation: String,
        message: String,
        source: Option<RedisError>,
    },
    CursorStore(Error),
    Config(String),
    PeerConnection {
        peer_id: String,
        message: String,
    },
    Decompression(String),
    StreamParse(String),
    SyncEngine(String),
    InvalidState {
        expected: String,
        actual: String,
    },
    Shutdown,
    Internal(String),
}

Errors that can occur during replication.

Each variant includes context about where the error occurred. Use is_retryable() to check if the operation should be retried.

Variants

Redis

Redis connection or command error.

Occurs when communicating with a peer’s Redis instance. These are typically retryable (network timeouts, connection drops).

Fields

operation: String

message: String

source: Option<RedisError>

CursorStore(Error)

SQLite error during cursor persistence.

Occurs when reading/writing cursor positions to SQLite. Not retryable - indicates local database issues that need attention.

Config(String)

Invalid or missing configuration.

Occurs during engine initialization if config is malformed. Not retryable - fix the configuration and restart.

PeerConnection

Peer connection failure.

Occurs when a peer is unreachable or the connection drops. Retryable with exponential backoff.

Fields

peer_id: String

message: String

Decompression(String)

Zstd decompression failure.

Occurs when CDC event payload is corrupted or truncated. Not retryable - the data is corrupt at the source.

StreamParse(String)

CDC stream event parsing failure.

Occurs when a Redis stream entry has unexpected format. Not retryable - the event is malformed at the source.

SyncEngine(String)

Sync engine communication failure.

Occurs when submitting to the local sync engine fails. Retryable - sync engine may be temporarily overloaded.

InvalidState

Engine state machine violation.

Occurs when an operation is attempted in the wrong state (e.g., calling start() on an already-running engine). Not retryable - indicates a bug in the caller.

Fields

expected: String

actual: String

Shutdown

Shutdown in progress.

Returned when operations are attempted during shutdown. Not retryable - engine is terminating.

Internal(String)

Unexpected internal error.

Catch-all for errors that shouldn’t happen. Not retryable - indicates a bug that needs investigation.

Implementations

impl ReplicationError

pub fn redis(operation: impl Into<String>, source: RedisError) -> Self

Create a Redis error from a redis::RedisError

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

Create a Redis error without source

pub fn is_retryable(&self) -> bool

Check if this error is retryable

Trait Implementations

impl Debug for ReplicationError

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

Formats the value using the given formatter.

impl Display for ReplicationError

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

Formats the value using the given formatter.

impl Error for ReplicationError

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 ReplicationError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<RedisError> for ReplicationError

fn from(e: RedisError) -> Self

Converts to this type from the input type.