Enum ClientError 

pub enum ClientError {
    AddressValidation(IdentifierValidationError),
    PublishError(String),
    Storage(StorageError),
    Api(ApiError),
    Identity(IdentityError),
    TlsError(Error),
    KeyPackageVerification(KeyPackageVerificationError),
    StreamInconsistency(String),
    Association(AssociationError),
    SignatureValidation(SignatureError),
    IdentityUpdate(IdentityUpdateError),
    SignatureRequest(SignatureRequestError),
    Group(Box<GroupError>),
    LocalEvent(LocalEventError),
    Db(ConnectionError),
    Generic(String),
    MlsStore(MlsStoreError),
    EnrichMessage(EnrichMessageError),
    Conversion(ConversionError),
    RegistrationNotVisible,
    AlreadyClosed,
    ConfigurationUnavailable(Box<ConfigurationFetchError>),
    ConfigurationInvalid(ServerConfigurationError),
    BackendMismatch {
        stored: String,
        received: String,
    },
    ClientVersionTooOld {
        client: String,
        minimum: String,
    },
    AuthRequired {
        required_scopes: Vec<String>,
    },
    ChainNotAccepted {
        chain: String,
        accepted: Vec<String>,
    },
}

Variants

AddressValidation(IdentifierValidationError)

PublishError(String)

Could not publish.

Failed to publish messages to the network. May be retryable.

Storage(StorageError)

Storage error.

Database operation failed. May be retryable.

Api(ApiError)

API error.

Network request to XMTP backend failed. Retryable.

Identity(IdentityError)

Identity error.

Problem with identity operations. Not retryable.

TlsError(Error)

TLS Codec error.

Encoding/decoding MLS TLS structures failed. Not retryable.

KeyPackageVerification(KeyPackageVerificationError)

Key package verification failed.

Invalid key package received from network. Not retryable.

StreamInconsistency(String)

Stream inconsistency.

Message stream state became inconsistent. Not retryable.

Association(AssociationError)

Association error.

Identity association operation failed. Not retryable.

SignatureValidation(SignatureError)

Signature validation error.

A signature failed verification. Not retryable.

IdentityUpdate(IdentityUpdateError)

Identity update error.

Failed to process identity update. Not retryable.

SignatureRequest(SignatureRequestError)

Signature request error.

Failed to create/process signature request. Not retryable.

Group(Box<GroupError>)

Group error.

Group operation failed. May be retryable.

LocalEvent(LocalEventError)

Local event error.

Failed to process local event. Not retryable.

Db(ConnectionError)

Database connection error.

Connection to database failed. Retryable.

Generic(String)

Generic error.

Unclassified error. May be retryable.

MlsStore(MlsStoreError)

MLS store error.

OpenMLS key store operation failed. Not retryable.

EnrichMessage(EnrichMessageError)

Message enrichment error.

Failed to enrich message content. Not retryable.

Conversion(ConversionError)

Conversion Error

Data type failed to convert. Not retryable.

RegistrationNotVisible

Registration not visible.

Registration has no publish cursor or is not visible before the timeout. Not retryable.

AlreadyClosed

Client is closed.

Operation was attempted on a client that has been shut down via Client::close. Not retryable — build a new client instead.

ConfigurationUnavailable(Box<ConfigurationFetchError>)

Server configuration unavailable.

The backend did not serve its configuration, or the answer could not be stored. A backend older than spec 006 answers UNIMPLEMENTED; there is no compatibility shim. Retryable exactly when the wrapped failure is: an unreachable backend is worth another attempt, UNIMPLEMENTED is not.

ConfigurationInvalid(ServerConfigurationError)

Server configuration invalid.

The backend published a configuration this client cannot use: a missing or malformed identifier, a minimum version that does not parse, or a chain that is not a CAIP-2 identifier. Not retryable.

BackendMismatch

Backend mismatch.

This database is bound to one backend deployment and a different one answered. Not retryable — use a database created for the backend this app now points at.

Fields

stored: String

received: String

ClientVersionTooOld

Client version too old.

The backend requires a newer libxmtp than this build. Not retryable — ship an updated client.

Fields

client: String

minimum: String

AuthRequired

Authentication required.

The backend requires a credential and none was configured. Not retryable — supply an auth callback or handle before building.

Fields

required_scopes: Vec<String>

ChainNotAccepted

Chain not accepted.

The backend does not verify smart contract wallet signatures on this chain. Not retryable — use a chain the deployment accepts.

Fields

chain: String

accepted: Vec<String>

Implementations

impl ClientError

pub fn db_needs_connection(&self) -> bool

Trait Implementations

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

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 ErrorCode for ClientError

fn error_code(&self) -> &'static str

Returns the unique error code for this error.

impl From<&ConfigurationLatch> for ClientError

fn from(latch: &ConfigurationLatch) -> Self

Converts to this type from the input type.

impl From<&str> for ClientError

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<ApiError> for ClientError

fn from(source: ApiError) -> Self

Converts to this type from the input type.

impl From<AssociationError> for ClientError

fn from(source: AssociationError) -> Self

Converts to this type from the input type.

impl From<ClientError> for ClientBuilderError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for DeviceSyncError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for GroupError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for IdentityDependencyError

fn from(error: ClientError) -> Self

Converts to this type from the input type.

impl From<ClientError> for InstallationDiffError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ConnectionError> for ClientError

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.

impl From<ConversionError> for ClientError

fn from(source: ConversionError) -> Self

Converts to this type from the input type.

impl From<EnrichMessageError> for ClientError

fn from(source: EnrichMessageError) -> Self

Converts to this type from the input type.

impl From<Error> for ClientError

fn from(source: TlsCodecError) -> Self

Converts to this type from the input type.

impl From<GroupError> for ClientError

fn from(err: GroupError) -> ClientError

Converts to this type from the input type.

impl From<IdentifierValidationError> for ClientError

fn from(source: IdentifierValidationError) -> Self

Converts to this type from the input type.

impl From<IdentityError> for ClientError

fn from(source: IdentityError) -> Self

Converts to this type from the input type.

impl From<IdentityUpdateError> for ClientError

fn from(source: IdentityUpdateError) -> Self

Converts to this type from the input type.

impl From<KeyPackageVerificationError> for ClientError

fn from(source: KeyPackageVerificationError) -> Self

Converts to this type from the input type.

impl From<LocalEventError> for ClientError

fn from(source: LocalEventError) -> Self

Converts to this type from the input type.

impl From<MlsStoreError> for ClientError

fn from(source: MlsStoreError) -> Self

Converts to this type from the input type.

impl From<NotFound> for ClientError

fn from(value: NotFound) -> Self

Converts to this type from the input type.

impl From<ServerConfigurationError> for ClientError

fn from(source: ServerConfigurationError) -> Self

Converts to this type from the input type.

impl From<SignatureError> for ClientError

fn from(source: SignatureError) -> Self

Converts to this type from the input type.

impl From<SignatureRequestError> for ClientError

fn from(source: SignatureRequestError) -> Self

Converts to this type from the input type.

impl From<StorageError> for ClientError

fn from(source: StorageError) -> Self

Converts to this type from the input type.

impl From<String> for ClientError

fn from(value: String) -> Self

Converts to this type from the input type.

impl RetryableError for ClientError

fn is_retryable(&self) -> bool