Enum Error 

pub enum Error {
    Runtime(String),
    Value(String),
    Assertion(String),
    NotConnected,
    ObjectTypeMismatch {
        expected: ObjectType,
        actual: ObjectType,
    },
    Request(Box<Error>),
    WebSocket(Box<Error>),
    Serde(Error),
    Io(Error),
}

Errors that can occur while using the client.

The variants mirror the exceptions raised by the original Python client: Error::Runtime corresponds to RuntimeError, Error::Value to ValueError and Error::Assertion to AssertionError.

Variants

Runtime(String)

A runtime error, e.g. a non-successful HTTP response or a failed check.

Value(String)

An invalid argument was provided.

Assertion(String)

An assertion about the provided arguments failed.

NotConnected

A connection based operation was attempted without an open connection.

ObjectTypeMismatch

The server returned an object whose type differs from the requested one.

Fields

expected: ObjectType

The object type that was requested.

actual: ObjectType

The object type the server actually returned.

Request(Box<Error>)

The underlying HTTP transport failed.

WebSocket(Box<Error>)

The underlying websocket transport failed.

Serde(Error)

(De)serialization of a JSON payload failed.

Io(Error)

An I/O operation (e.g. reading a model file) failed.

Implementations

impl Error

pub fn runtime(message: impl Into<String>) -> Self

Creates a Error::Runtime from anything string-like.

pub fn value(message: impl Into<String>) -> Self

Creates a Error::Value from anything string-like.

pub fn assertion(message: impl Into<String>) -> Self

Creates a Error::Assertion from anything string-like.

pub fn object_type_mismatch(expected: ObjectType, actual: ObjectType) -> Self

Creates an Error::ObjectTypeMismatch from the requested and actual types.

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.