Enum Error 

#[non_exhaustive]
pub enum Error {
    NotStarted,
    AlreadyStarted,
    InvalidConfiguration(String),
    Core(Error),
    Transport(Error),
    Router(Error),
    Reliability(Error),
    Mls(MlsError),
    MlsNotInitialized,
    NoKeyPackage(String),
    SessionNotReady(EstablishmentState),
    EncryptFailed(String),
    Service(ServiceError),
    Serialization(String),
    UserBlocked(String),
    MediaTransferLimit(String),
    GroupNotFound(String),
    PermissionDenied(String),
    InvalidState(String),
    InvalidArgument(String),
    DataDisabled,
    DataStorageUnavailable,
    DocTooLarge {
        actual: usize,
        limit: usize,
    },
    DataCorrupted(String),
    TelemetryConfigInvalid(String),
    Other(String),
}

Protocol errors.

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.

NotStarted

Protocol not started.

AlreadyStarted

Protocol already started.

InvalidConfiguration(String)

Invalid configuration.

Core(Error)

Core error.

Transport(Error)

Transport error.

Router(Error)

Router error.

Reliability(Error)

Reliability error.

Mls(MlsError)

MLS error.

MlsNotInitialized

MLS not initialized.

NoKeyPackage(String)

No key package available for recipient.

SessionNotReady(EstablishmentState)

Session not ready; establishment in progress. Caller can retry or show “Establishing…”.

EncryptFailed(String)

Outbound message encryption failed.

Service(ServiceError)

Service error.

Serialization(String)

Serialization error.

UserBlocked(String)

Operation rejected because the target user is blocked.

MediaTransferLimit(String)

Too many concurrent media transfers to the same recipient. Encrypted transfers share the recipient’s session ratchet, whose out-of-order tolerance bounds how many chunks may be in flight at once.

GroupNotFound(String)

Group does not exist locally.

PermissionDenied(String)

Operation requires a group role or permission the caller does not hold.

InvalidState(String)

Operation rejected by the current group or protocol state (e.g. last-admin constraints, member limits, expired key packages).

InvalidArgument(String)

A caller-supplied argument failed validation.

DataDisabled

The data layer is switched off in configuration.

DataStorageUnavailable

The data layer has no storage backend to work with.

Raised when the engine has no protocol-state store yet, which means initialize_mls has not run: documents are sealed at rest, and the record key that seals them is minted during that call.

DocTooLarge

A document has grown past the per-document cap.

The change that breached it is already durable, so nothing is lost. What is refused is further growth: deletions still apply, so a document can be brought back under the cap and resume accepting edits.

Fields

actual: usize

The compacted size that breached the cap.

limit: usize

The cap in force.

DataCorrupted(String)

Document data could not be decoded.

Documents are read back out of sealed records, so their bytes have already been authenticated. This therefore reports a permanent verdict, not a transient read failure worth retrying.

TelemetryConfigInvalid(String)

A telemetry configuration field failed validation; the payload names the field. Raised by enable_telemetry before anything is built.

Other(String)

Generic error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<MlsError> for Error

fn from(source: MlsError) -> Self

Converts to this type from the input type.

impl From<SealedError> for Error

Carries a sealed-layer failure in as the MLS error it has always been.

The envelope codec and the group-id constructor used to raise MlsError directly; they now raise SealedError, which the MLS crate maps back variant for variant. Routing through that mapping rather than inventing a new variant here is what keeps Error::Mls matching, the SessionStateError classification above, and the rendered text identical to what callers saw before the move.

fn from(err: SealedError) -> Self

Converts to this type from the input type.

impl From<ServiceError> for Error

fn from(source: ServiceError) -> Self

Converts to this type from the input type.