Enum CommissioningError 

#[non_exhaustive]
pub enum CommissioningError {
    InvalidConfig(&'static str),
    UnexpectedResponseKind {
        expected: Expectation,
        got: Expectation,
    },
    OutOfOrderResponse(Stage),
    DeviceImStatus {
        stage: Stage,
        im_status: u16,
    },
    MalformedResponse(Stage),
    Attestation(AttestationError),
    Noc(NocError),
    CaseEstablishmentFailed,
    NetworkFeatureUnsupported {
        needed: NetworkKind,
    },
    NetworkRejected {
        stage: Stage,
        networking_status: u8,
        debug_text: Option<String>,
        remediation_hint: RemediationHint,
    },
}

Errors emitted by the commissioning state machine.

All variants are #[non_exhaustive] — future sub-phases or future milestones (M6.5 network commissioning, etc.) can add variants without breaking SemVer.

CommissioningError is intentionally not Clone. The summary emitted in super::Action::Abort is a pre-rendered String, so callers never need to clone the full error.

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.

InvalidConfig(&'static str)

CommissionerConfig failed validation in Commissioner::new. Carries a &'static str describing which field is bad — no alloc on the error path.

UnexpectedResponseKind

Caller invoked on_response with an Expectation that does not match the last poll()’s emitted Expectation.

Fields

expected: Expectation

The Expectation the state machine emitted with the last Action.

got: Expectation

The Expectation the caller passed in.

OutOfOrderResponse(Stage)

Caller invoked on_response or on_case_established in a stage where the state machine is not waiting for input (e.g. Stage::Cleanup or Stage::SecurePairing).

DeviceImStatus

Device returned a non-OK Interaction Model status for a cluster command at stage. The 16-bit im_status is the canonical Matter status code from the response envelope.

Fields

stage: Stage

Where the rejection happened.

im_status: u16

IM status code (Matter Core Spec §8.10).

MalformedResponse(Stage)

Response TLV failed to decode at the cluster command level.

Attestation(AttestationError)

Attestation verification failed (chain / signature / CD).

Noc(NocError)

CSR verification or NOC issuance failed.

CaseEstablishmentFailed

CASE establishment failed (caller called on_response(Expectation::CaseFailed, &[])).

NetworkFeatureUnsupported

The device’s NetworkCommissioning::FeatureMap does not declare the network type the caller supplied credentials for (e.g. NetworkCredentials::Thread was supplied but the device’s FeatureMap lacks the Thread bit). Both Wi-Fi and Thread are supported network types as of M9-C2 — this variant signals a device/credential mismatch, not an unsupported network type.

Wording pinned: WeaveHome substring-matches does not support Thread network type to route Wi-Fi-only devices off its automatic Thread path. Do not reword without coordinating — the typed replacement is matter_controller::Error::network_feature_unsupported().

Fields

needed: NetworkKind

Which network type the supplied credentials required.

NetworkRejected

Device rejected AddOrUpdateWiFiNetwork or ConnectNetwork with a non-OK NetworkCommissioningStatusEnum value (spec §11.9.5.1).

Fields

stage: Stage

Which stage the device rejected.

networking_status: u8

Raw NetworkCommissioningStatusEnum value from the response.

debug_text: Option<String>

Optional human-readable debug text echoed by the device, capped at the spec’s 512-octet bound at decode. Device-controlled free text — it may name networks (e.g. an SSID); log deliberately.

remediation_hint: RemediationHint

Mapped remediation category for downstream UI rendering.

Trait Implementations

impl Debug for CommissioningError

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

Formats the value using the given formatter.

impl Display for CommissioningError

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

Formats the value using the given formatter.

impl Error for CommissioningError

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<AttestationError> for CommissioningError

fn from(source: AttestationError) -> Self

Converts to this type from the input type.

impl From<NocError> for CommissioningError

fn from(source: NocError) -> Self

Converts to this type from the input type.