Enum SignalMaintenanceError 

#[non_exhaustive]
pub enum SignalMaintenanceError {
    CorruptKey(String),
    Storage(Error),
    Iq(IqError),
    Signal(SignalProtocolError),
    DrainCommitFailed,
    DrainShuttingDown,
}

Failures of the background Signal maintenance surface: signed pre-key rotation (Client::rotate_signed_pre_key) and cache durability (Client::flush_pending_signal_state).

The split that matters to a caller is corruption versus everything else: Self::CorruptKey will keep failing until the stored material is replaced, while storage, IQ and drain failures are worth retrying.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CorruptKey(String)

Key material is unusable: bad encoding, or a missing/wrong-sized field. Almost always a staged record that a retry would read back identically.

Storage(Error)

The storage backend failed a read, write or flush.

Iq(IqError)

The rotation IQ was rejected by the server or never reached it.

Signal(SignalProtocolError)

A Signal primitive failed (e.g. signing the new signed pre-key).

DrainCommitFailed

The inbound drain batch could not be committed, so the Signal cache was left unflushed on purpose and the server redelivers those messages.

DrainShuttingDown

The client is going away while an inbound drain is active; flushing there would persist ratchet advances whose messages have no durable row.

Trait Implementations

impl Debug for SignalMaintenanceError

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

Formats the value using the given formatter.

impl Display for SignalMaintenanceError

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

Formats the value using the given formatter.

impl Error for SignalMaintenanceError

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<IqError> for SignalMaintenanceError

fn from(source: IqError) -> Self

Converts to this type from the input type.

impl From<SignalMaintenanceError> for SignalError

fn from(err: SignalMaintenanceError) -> Self

Converts to this type from the input type.

impl From<SignalProtocolError> for SignalMaintenanceError

fn from(source: SignalProtocolError) -> Self

Converts to this type from the input type.