Enum GroupError 

pub enum GroupError {
    OutgoingPreparation(OutgoingPreparationError),
    NotFound(NotFound),
    UserLimitExceeded,
    MissingSequenceId,
    AddressNotFound(Vec<String>),
    WrappedApi(ApiError),
    InvalidGroupMembership,
    LeaveCantProcessed(GroupLeaveValidationError),
    Storage(StorageError),
    Intent(IntentError),
    CreateMessage(CreateMessageError),
    TlsError(Error),
    UpdateGroupMembership(UpdateGroupMembershipError<SqlKeyStoreError>),
    GroupCreate(NewGroupError<SqlKeyStoreError>),
    SelfUpdate(SelfUpdateError<SqlKeyStoreError>),
    WelcomeError(WelcomeError<SqlKeyStoreError>),
    InvalidExtension(InvalidExtensionError),
    Signature(SignatureError),
    Client(ClientError),
    ReceiveError(GroupMessageProcessingError),
    AddressValidation(IdentifierValidationError),
    LocalEvent(LocalEventError),
    InvalidPublicKeys(Vec<Vec<u8>>),
    CommitValidation(CommitValidationError),
    Identity(IdentityError),
    ConversionError(ConversionError),
    CryptoError(CryptoError),
    CreateGroupContextExtProposalError(CreateGroupContextExtProposalError<SqlKeyStoreError>),
    ProposeAddMember(ProposeAddMemberError<SqlKeyStoreError>),
    ProposeRemoveMember(ProposeRemoveMemberError<SqlKeyStoreError>),
    Proposal(ProposalError<SqlKeyStoreError>),
    CommitToPendingProposals(CommitToPendingProposalsError<SqlKeyStoreError>),
    MergePendingCommit(MergePendingCommitError<SqlKeyStoreError>),
    ProposalsNotSupported(String),
    MinVersionExceedsOwnVersion {
        requested: String,
        own: String,
    },
    MinVersionDowngrade {
        requested: String,
        current: String,
    },
    InvalidMinVersion {
        value: String,
        reason: String,
    },
    ComponentSource(ComponentSourceError),
    AppDataCommit(GroupAppDataError<SqlKeyStoreError>),
    BootstrapSynthesis(BootstrapSynthesisError),
    BootstrapCommit(BootstrapCommitError<SqlKeyStoreError>),
    CredentialError(BasicCredentialError),
    LeafNodeError(LibraryError),
    InstallationDiff(InstallationDiffError),
    NoPSKSupport,
    SqlKeyStore(SqlKeyStoreError),
    SyncFailedToWait(Box<SyncSummary>),
    StreamBarrier(BarrierError),
    PublishedButUnconfirmed {
        intent_id: i32,
        cause: Option<Box<BarrierError>>,
    },
    MissingPendingCommit,
    ProcessIntent(ProcessIntentError),
    LockUnavailable,
    TooManyCharacters {
        length: usize,
    },
    AppDataSuperseded {
        expected: String,
        actual: String,
    },
    GroupPausedUntilUpdate(String),
    GroupInactive,
    Sync(Box<SyncSummary>),
    Db(ConnectionError),
    MlsStore(MlsStoreError),
    MetadataPermissionsError(MetadataPermissionsError),
    FailedToVerifyInstallations(FailedInstallationIds),
    NoWelcomesToSend,
    CodecError(CodecError),
    WrapWelcome(WrapPayloadError),
    UnwrapWelcome(UnwrapPayloadError),
    WelcomeDataNotFound(String),
    WelcomeGroupPrefixPending {
        group_id: GroupId,
        anchor: u64,
    },
    InvalidWelcomeMetadata,
    UnsupportedWelcomeVersion(String),
    UninitializedResult,
    Diesel(Error),
    UninitializedField(UninitializedFieldError),
    DeleteMessage(DeleteMessageError),
    DeviceSync(Box<DeviceSyncError>),
}

Variants

OutgoingPreparation(OutgoingPreparationError)

NotFound(NotFound)

UserLimitExceeded

Max user limit exceeded.

Attempted to add too many members. Not retryable.

MissingSequenceId

Sequence ID not found.

No sequence ID for an inbox after an identity-update refresh — its registration hasn’t propagated yet. Retryable.

AddressNotFound(Vec<String>)

Addresses not found.

Specified addresses have no XMTP identity. Not retryable.

WrappedApi(ApiError)

API error.

Network request failed. Retryable.

InvalidGroupMembership

Invalid group membership.

Group membership state is invalid. Not retryable.

LeaveCantProcessed(GroupLeaveValidationError)

Leave cannot be processed.

Group leave validation failed. Not retryable.

Storage(StorageError)

Storage error.

Database operation failed. May be retryable.

Intent(IntentError)

Intent error.

Failed to process group intent. Not retryable.

CreateMessage(CreateMessageError)

Create message error.

MLS message creation failed. Not retryable.

TlsError(Error)

TLS codec error.

MLS TLS encoding/decoding failed. Not retryable.

UpdateGroupMembership(UpdateGroupMembershipError<SqlKeyStoreError>)

Update group membership error.

Failed to update group membership. May be retryable.

GroupCreate(NewGroupError<SqlKeyStoreError>)

Group create error.

MLS group creation failed. May be retryable.

SelfUpdate(SelfUpdateError<SqlKeyStoreError>)

Self update error.

MLS self-update operation failed. May be retryable.

WelcomeError(WelcomeError<SqlKeyStoreError>)

Welcome error.

Processing MLS welcome message failed. May be retryable.

InvalidExtension(InvalidExtensionError)

Invalid extension.

MLS extension validation failed. Not retryable.

Signature(SignatureError)

Invalid signature.

MLS signature verification failed. Not retryable.

Client(ClientError)

Client error.

Client operation failed within group. May be retryable.

ReceiveError(GroupMessageProcessingError)

Receive error.

Processing received group message failed. May be retryable.

AddressValidation(IdentifierValidationError)

Address validation error.

An address/identifier is invalid. Not retryable.

LocalEvent(LocalEventError)

Local event error.

Failed to process local event. Not retryable.

InvalidPublicKeys(Vec<Vec<u8>>)

Invalid public keys.

Keys are not valid Ed25519 public keys. Not retryable.

CommitValidation(CommitValidationError)

Commit validation error.

MLS commit validation failed. May be retryable.

Identity(IdentityError)

Identity error.

Identity operation failed. Not retryable.

ConversionError(ConversionError)

Conversion error.

Proto conversion failed. Not retryable.

CryptoError(CryptoError)

Crypto error.

Cryptographic operation failed. Not retryable.

CreateGroupContextExtProposalError(CreateGroupContextExtProposalError<SqlKeyStoreError>)

Group context proposal error.

Failed to create group context extension proposal. May be retryable.

ProposeAddMember(ProposeAddMemberError<SqlKeyStoreError>)

Propose add member error.

Failed to create an add-member proposal. May be retryable.

ProposeRemoveMember(ProposeRemoveMemberError<SqlKeyStoreError>)

Propose remove member error.

Failed to create a remove-member proposal. May be retryable.

Proposal(ProposalError<SqlKeyStoreError>)

Proposal error.

Generic MLS proposal creation/handling failure. May be retryable.

CommitToPendingProposals(CommitToPendingProposalsError<SqlKeyStoreError>)

Commit to pending proposals error.

Failed to commit pending proposals into an MLS commit. May be retryable.

MergePendingCommit(MergePendingCommitError<SqlKeyStoreError>)

Merge pending commit error.

Failed to merge a pending commit into local state. May be retryable.

ProposalsNotSupported(String)

Proposals not supported.

Encountered a proposal when our client does not support proposals. Not retryable.

MinVersionExceedsOwnVersion

Caller asked to set MIN_SUPPORTED_PROTOCOL_VERSION to a value the caller’s own client does not satisfy. Refusing prevents the caller from immediately pausing themselves (and every peer at or below their version) the moment the bump lands. Not retryable.

Fields

requested: String

own: String

MinVersionDowngrade

Caller asked to lower MIN_SUPPORTED_PROTOCOL_VERSION below the floor already on the group. Monotonic-only: a downgrade would silently unpause peers between the old and new floors, defeating the gate. Not retryable.

Fields

requested: String

current: String

InvalidMinVersion

Caller passed a min_version string that doesn’t parse as semver. Surfaces from the send-side paths (enable_proposals, update_group_min_version) so SDK consumers can match-handle malformed input without parsing string-flattened wrappers. Not retryable.

Fields

value: String

reason: String

ComponentSource(ComponentSourceError)

Component source error.

Failed to encode, decode, or look up a well-known component during the AppDataUpdate path. Not retryable.

AppDataCommit(GroupAppDataError<SqlKeyStoreError>)

AppData commit error.

Failed to build or stage a commit that bundles an inline AppDataUpdate proposal. Wraps the structured GroupAppDataError from stage_app_data_propose_and_commit so the underlying OpenMLS create/stage failure is preserved instead of being string-flattened.

BootstrapSynthesis(BootstrapSynthesisError)

Bootstrap synthesis failure — sender-side couldn’t build the complete set of initial component values for the migration commit. Includes identity-update lookup failures.

Conditionally retryable: delegates to the wrapped super::app_data::migration::BootstrapSynthesisError, which retries only when an inner identity-update API error is itself retryable. Decode/registry-shape failures are deterministic and not retryable.

BootstrapCommit(BootstrapCommitError<SqlKeyStoreError>)

Bootstrap commit-build failure.

Not retryable: every variant of super::app_data::migration::BootstrapCommitError is a deterministic OpenMLS commit failure, a TLS codec error, or a caller-side precondition violation.

CredentialError(BasicCredentialError)

Credential error.

MLS credential validation failed. Not retryable.

LeafNodeError(LibraryError)

Leaf node error.

MLS leaf node operation failed. Not retryable.

InstallationDiff(InstallationDiffError)

Installation diff error.

Installation diff computation failed. May be retryable.

NoPSKSupport

No PSK support.

Pre-shared keys are not supported. Not retryable.

SqlKeyStore(SqlKeyStoreError)

SQL key store error.

OpenMLS key store operation failed. May be retryable.

SyncFailedToWait(Box<SyncSummary>)

Sync failed to wait.

Waiting for intent sync failed. Retryable.

StreamBarrier(BarrierError)

Durable processing did not meet the fixed network targets. May be retryable.

PublishedButUnconfirmed

The exact published attempt remains pending. A later call can confirm it. Retryable.

Fields

intent_id: i32

cause: Option<Box<BarrierError>>

MissingPendingCommit

Missing pending commit.

Expected pending commit not found. Not retryable.

ProcessIntent(ProcessIntentError)

Process intent error.

Failed to process group intent. May be retryable.

LockUnavailable

Failed to load lock.

Concurrency lock acquisition failed. Retryable.

TooManyCharacters

Exceeded max characters.

Field value exceeds character limit. Not retryable.

Fields

length: usize

AppDataSuperseded

A guarded metadata update was abandoned because another member changed the field first.

Not retryable as-is: the value was derived from state that no longer exists. Re-derive it from actual and queue a new update. Distinct from a sync failure — nothing went wrong, the write is just stale.

Fields

expected: String

actual: String

GroupPausedUntilUpdate(String)

Group paused until update.

Group is paused until a newer version is available. Not retryable.

GroupInactive

Group is inactive.

Operation on an inactive group. Not retryable.

Sync(Box<SyncSummary>)

Sync summary.

Sync operation completed with errors. May be retryable.

Db(ConnectionError)

Database connection error.

Database connection failed. Retryable.

MlsStore(MlsStoreError)

MLS store error.

OpenMLS key store failed. Not retryable.

MetadataPermissionsError(MetadataPermissionsError)

Metadata permissions error.

Metadata permission check failed. Not retryable.

FailedToVerifyInstallations(FailedInstallationIds)

Failed to verify installations.

Installation verification failed. Not retryable.

NoWelcomesToSend

No welcomes to send.

No welcome messages to send to new members. Not retryable.

CodecError(CodecError)

Codec error.

Content type codec failed. Retryable.

WrapWelcome(WrapPayloadError)

Wrap welcome error.

Failed to wrap welcome message. Not retryable.

UnwrapWelcome(UnwrapPayloadError)

Unwrap welcome error.

Failed to unwrap welcome message. Not retryable.

WelcomeDataNotFound(String)

Welcome data not found.

Welcome data missing from topic. Not retryable.

WelcomeGroupPrefixPending

The old group must process its ordered prefix before this Welcome can install. Retryable.

Fields

group_id: GroupId

anchor: u64

InvalidWelcomeMetadata

The Welcome has missing, malformed, or out-of-range join metadata. Not retryable.

UnsupportedWelcomeVersion(String)

The Welcome needs a newer client. Keep it blocked until upgrade. Retryable.

UninitializedResult

Result not initialized.

Expected result was not initialized. Not retryable.

Diesel(Error)

Diesel ORM error.

Raw database query failed. May be retryable.

UninitializedField(UninitializedFieldError)

Uninitialized field.

Builder field not initialized. Not retryable.

DeleteMessage(DeleteMessageError)

Delete message error.

Failed to delete message. Not retryable.

DeviceSync(Box<DeviceSyncError>)

Device sync error.

Device sync operation failed. May be retryable.

Trait Implementations

impl Debug for GroupError

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

Formats the value using the given formatter.

impl Display for GroupError

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

Formats the value using the given formatter.

impl Error for GroupError

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 GroupError

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

Returns the unique error code for this error.

impl From<ApiError> for GroupError

fn from(source: ApiError) -> Self

Converts to this type from the input type.

impl From<BarrierError> for GroupError

fn from(source: BarrierError) -> Self

Converts to this type from the input type.

impl From<BasicCredentialError> for GroupError

fn from(source: BasicCredentialError) -> Self

Converts to this type from the input type.

impl From<BootstrapCommitError<SqlKeyStoreError>> for GroupError

fn from(source: BootstrapCommitError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<BootstrapSynthesisError> for GroupError

fn from(source: BootstrapSynthesisError) -> Self

Converts to this type from the input type.

impl From<Box<DeviceSyncError>> for GroupError

fn from(source: Box<DeviceSyncError>) -> Self

Converts to this type from the input type.

impl From<Box<SyncSummary>> for GroupError

fn from(source: Box<SyncSummary>) -> 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<CodecError> for GroupError

fn from(source: CodecError) -> Self

Converts to this type from the input type.

impl From<CommitToPendingProposalsError<SqlKeyStoreError>> for GroupError

fn from(source: CommitToPendingProposalsError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<CommitValidationError> for GroupError

fn from(source: CommitValidationError) -> Self

Converts to this type from the input type.

impl From<ComponentSourceError> for GroupError

fn from(source: ComponentSourceError) -> Self

Converts to this type from the input type.

impl From<ConnectionError> for GroupError

fn from(source: ConnectionError) -> Self

Converts to this type from the input type.

impl From<ConversionError> for GroupError

fn from(source: ConversionError) -> Self

Converts to this type from the input type.

impl From<CreateGroupContextExtProposalError<SqlKeyStoreError>> for GroupError

fn from(source: CreateGroupContextExtProposalError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<CreateMessageError> for GroupError

fn from(source: CreateMessageError) -> Self

Converts to this type from the input type.

impl From<CryptoError> for GroupError

fn from(source: CryptoError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for GroupError

fn from(value: DecodeError) -> Self

Converts to this type from the input type.

impl From<DeleteMessageError> for GroupError

fn from(source: DeleteMessageError) -> Self

Converts to this type from the input type.

impl From<EncodeError> for GroupError

fn from(value: EncodeError) -> Self

Converts to this type from the input type.

impl From<Error> for GroupError

fn from(source: TlsCodecError) -> Self

Converts to this type from the input type.

impl From<Error> for GroupError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<GroupAppDataError<SqlKeyStoreError>> for GroupError

fn from(source: GroupAppDataError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<GroupError> for CatchUpError

fn from(source: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupError> for ClientBuilderError

fn from(value: GroupError) -> 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<GroupError> for CommitLogError

fn from(source: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupError> for DeviceSyncError

fn from(source: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupError> for IncomingError

fn from(source: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupError> for NotificationError

fn from(source: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupError> for SubscribeError

fn from(value: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupError> for TaskWorkerError

fn from(source: GroupError) -> Self

Converts to this type from the input type.

impl From<GroupLeaveValidationError> for GroupError

fn from(source: GroupLeaveValidationError) -> Self

Converts to this type from the input type.

impl From<IdentifierValidationError> for GroupError

fn from(source: IdentifierValidationError) -> Self

Converts to this type from the input type.

impl From<IdentityError> for GroupError

fn from(source: IdentityError) -> Self

Converts to this type from the input type.

impl From<InstallationDiffError> for GroupError

fn from(source: InstallationDiffError) -> Self

Converts to this type from the input type.

impl From<IntentError> for GroupError

fn from(source: IntentError) -> Self

Converts to this type from the input type.

impl From<InvalidExtensionError> for GroupError

fn from(source: InvalidExtensionError) -> Self

Converts to this type from the input type.

impl From<LibraryError> for GroupError

fn from(source: LibraryError) -> Self

Converts to this type from the input type.

impl From<LocalEventError> for GroupError

fn from(source: LocalEventError) -> Self

Converts to this type from the input type.

impl From<MergePendingCommitError<SqlKeyStoreError>> for GroupError

fn from(source: MergePendingCommitError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<MetadataPermissionsError> for GroupError

fn from(source: MetadataPermissionsError) -> Self

Converts to this type from the input type.

impl From<MlsStoreError> for GroupError

fn from(source: MlsStoreError) -> Self

Converts to this type from the input type.

impl From<NewGroupError<SqlKeyStoreError>> for GroupError

fn from(source: NewGroupError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<NotFound> for GroupError

fn from(source: NotFound) -> Self

Converts to this type from the input type.

impl From<ProposalError<SqlKeyStoreError>> for GroupError

fn from(source: ProposalError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<ProposeAddMemberError<SqlKeyStoreError>> for GroupError

fn from(source: ProposeAddMemberError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<ProposeRemoveMemberError<SqlKeyStoreError>> for GroupError

fn from(source: ProposeRemoveMemberError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<SelfUpdateError<SqlKeyStoreError>> for GroupError

fn from(source: SelfUpdateError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<SignatureError> for GroupError

fn from(source: SignatureError) -> Self

Converts to this type from the input type.

impl From<SqlKeyStoreError> for GroupError

fn from(source: SqlKeyStoreError) -> Self

Converts to this type from the input type.

impl From<StorageError> for GroupError

fn from(source: StorageError) -> Self

Converts to this type from the input type.

impl From<SyncSummary> for GroupError

fn from(value: SyncSummary) -> Self

Converts to this type from the input type.

impl From<UninitializedFieldError> for GroupError

fn from(source: UninitializedFieldError) -> Self

Converts to this type from the input type.

impl From<UnwrapPayloadError> for GroupError

fn from(source: UnwrapPayloadError) -> Self

Converts to this type from the input type.

impl From<UpdateGroupMembershipError<SqlKeyStoreError>> for GroupError

fn from(source: UpdateGroupMembershipError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<WelcomeError<SqlKeyStoreError>> for GroupError

fn from(source: WelcomeError<SqlKeyStoreError>) -> Self

Converts to this type from the input type.

impl From<WrapPayloadError> for GroupError

fn from(source: WrapPayloadError) -> Self

Converts to this type from the input type.

impl NeedsDbReconnect for GroupError

fn needs_db_reconnect(&self) -> bool

Forwards a dropped-pool signal from storage-bearing variants so a worker catching GroupErrors per item can stop on disconnect; else false.

impl RetryableError for GroupError

fn is_retryable(&self) -> bool