Enum ComponentSourceError 

pub enum ComponentSourceError {
    UnknownComponent(ComponentId),
    NotImplemented(ComponentId),
    ImmutableUpdate(ComponentId),
    MismatchedMutation(ComponentId),
    InvalidInboxId(InboxIdError),
    MalformedComponentValue {
        component_id: ComponentId,
        reason: String,
    },
    UnknownMetadataField(String),
    GroupMutableMetadata(GroupMutableMetadataError),
    TlsCodec(Error),
    TlsSetApply(TlsSetError),
    TlsMapApply(TlsMapError),
    FieldBoundExceeded {
        component_id: ComponentId,
        len: usize,
        max: usize,
    },
}

Errors surfaced by the component_source layer.

xmtp_mls embeds this in GroupError via #[from] for the AppDataUpdate path.

Variants

UnknownComponent(ComponentId)

The component id is outside the well-known XMTP range.

NotImplemented(ComponentId)

The component is known but its wiring hasn’t been built yet.

ImmutableUpdate(ComponentId)

An AppDataUpdate::Update write was attempted against an immutable component. Insert-once writes should be expressed as Insert, not caught here.

MismatchedMutation(ComponentId)

A mutation does not match the component type of the component it targets (e.g. a scalar write to ADMIN_LIST).

InvalidInboxId(InboxIdError)

Failed to convert an inbox id string or byte slice into an InboxId. Wraps InboxIdError — callers that need to distinguish “not hex” from “wrong length” can match the inner variant.

MalformedComponentValue

A wire-format violation on a component value: the bytes stored in the AppData dictionary for a known component don’t decode under the expected encoding (e.g. non-UTF-8 bytes for a Bytes-typed metadata attribute, malformed TlsSet for a collection component).

Fields

component_id: ComponentId

The component whose stored bytes failed to decode.

reason: String

Human-readable reason — surface to logs, not user-facing.

UnknownMetadataField(String)

A MetadataUpdate intent referenced a metadata field name that has no corresponding ComponentId. Most commonly fires when a future metadata field is added to one of the senders without also being added to metadata_field_to_component_id.

GroupMutableMetadata(GroupMutableMetadataError)

Failed to read, decode, or encode the legacy group mutable metadata extension while servicing a component-source request.

TlsCodec(Error)

A TLS-codec operation on a delta or stored collection value failed.

TlsSetApply(TlsSetError)

A TlsSet::apply_delta call failed while synthesizing the new full value of a collection component from an incoming delta.

TlsMapApply(TlsMapError)

A TlsMap::apply_delta call failed while synthesizing the new full value of a map component from an incoming delta.

FieldBoundExceeded

An update would leave a bounded component holding a scalar, collection element, or collection snapshot longer than its limit (MAX_FIELD_ELEMENT_BYTES or MAX_FIELD_SNAPSHOT_BYTES).

Fields

component_id: ComponentId

The component whose new value is too large.

len: usize

Length of the offending scalar, element, or snapshot.

max: usize

The bound it exceeds.

Implementations

impl ComponentSourceError

pub fn component_id(&self) -> Option<ComponentId>

Best-effort ComponentId extraction for the variants that carry one — so error-mapping shims can preserve structured context across the crate boundary into GroupMutableMetadataError::MalformedComponent without stringifying.

Trait Implementations

impl Debug for ComponentSourceError

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

Formats the value using the given formatter.

impl Display for ComponentSourceError

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

Formats the value using the given formatter.

impl Error for ComponentSourceError

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<ComponentSourceError> for FieldError

fn from(source: ComponentSourceError) -> Self

Converts to this type from the input type.

impl From<ComponentSourceError> for GroupMutableMetadataError

fn from(err: ComponentSourceError) -> Self

Preserve structure where possible. If the source already wraps a GroupMutableMetadataError, unwrap and return that inner variant verbatim so callers can match on MissingExtension / MissingMetadataField / etc.

For every other variant, surface as MalformedComponent and preserve the offending component_id when it’s available so downstream consumers (bindings, error-mapping) can match structurally on it. Variants without one surface as component_id: None; the display string stays the authoritative diagnostic.

impl From<ComponentTypedError> for ComponentSourceError

fn from(err: ComponentTypedError) -> Self

Surface trait-layer errors at the dispatch boundary. The dispatch layer adds UnknownComponent / NotImplemented / UnknownMetadataField / GroupMutableMetadata for things the trait can’t see; the variants below are the trait’s domain and round-trip 1:1.

impl From<Error> for ComponentSourceError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<GroupMutableMetadataError> for ComponentSourceError

fn from(source: GroupMutableMetadataError) -> Self

Converts to this type from the input type.

impl From<InboxIdError> for ComponentSourceError

fn from(source: InboxIdError) -> Self

Converts to this type from the input type.

impl From<TlsMapError> for ComponentSourceError

fn from(source: TlsMapError) -> Self

Converts to this type from the input type.

impl From<TlsSetError> for ComponentSourceError

fn from(source: TlsSetError) -> Self

Converts to this type from the input type.