Enum Error 

#[non_exhaustive]
pub enum Error {
    Disconnected(DisconnectReason),
    Frame(FrameError),
    Handshake(HandshakeError),
    Config(String),
    Io(Error),
    TaskFailed,
}

Top-level error returned by the ESPHome native API.

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.

Disconnected(DisconnectReason)

The connection ended. This is an expected lifecycle event, not necessarily a failure — inspect the DisconnectReason to decide.

Frame(FrameError)

A frame could not be turned into a message. The connection is no longer in a known state and is torn down.

Handshake(HandshakeError)

Connection establishment or the encryption handshake failed.

Config(String)

The API was misconfigured (for example, an encryption key that is not valid base64).

Io(Error)

An unexpected I/O error that is not a normal disconnect.

TaskFailed

The connection’s background task terminated without reporting an outcome (for example, it panicked). The session is over, but nothing is known about how it ended.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FrameError> for Error

fn from(source: FrameError) -> Self

Converts to this type from the input type.

impl From<HandshakeError> for Error

fn from(source: HandshakeError) -> Self

Converts to this type from the input type.