Enum IotError 

#[non_exhaustive]
pub enum IotError {
    NotConnected,
    ConnectionFailed(SmolStr),
    AuthFailed(SmolStr),
    Timeout,
    PathNotBound(PropertyPath),
    PathKindMismatch {
        path: PropertyPath,
        expected: &'static str,
    },
    Codec(CodecError),
    Transport(TransportError),
    Protocol(SmolStr),
}

Top-level error every public API in the SDK returns.

Protocol-specific variants are intentionally not enumerated here — they live in their own crates and are wrapped via the protocol crate’s own error type (which itself wraps CodecError / TransportError for the shared sub-failures). The conversion from a protocol-specific error to IotError happens at the boundary between the protocol crate and the gateway / IotClient layer.

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.

NotConnected

Operation requested while the client is not connected.

ConnectionFailed(SmolStr)

Connection establishment failed.

AuthFailed(SmolStr)

Authentication failed (bad credentials, expired cert, …).

Timeout

Operation timed out (any layer).

PathNotBound(PropertyPath)

The target PropertyPath is not in the active mapping.

PathKindMismatch

The path is bound but the binding kind does not match the protocol (e.g. asking the MQTT client to handle a Modbus binding).

Fields

path: PropertyPath

The path that triggered the mismatch.

expected: &'static str

Human-readable description of the expected binding variant.

Codec(CodecError)

Codec error shared with the protocol layer.

Transport(TransportError)

Transport error shared with the protocol layer.

Protocol(SmolStr)

Catch-all for protocol-specific failures.

Trait Implementations

impl Debug for IotError

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

Formats the value using the given formatter.

impl Display for IotError

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

Formats the value using the given formatter.

impl Error for IotError

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<CodecError> for IotError

fn from(e: CodecError) -> Self

Converts to this type from the input type.

impl From<TransportError> for IotError

fn from(e: TransportError) -> Self

Converts to this type from the input type.