Enum Error 

#[non_exhaustive]
pub enum Error {
    Http(CanopyHttpError),
    Decode {
        path: String,
        source: Error,
    },
    Encode {
        path: String,
        source: Error,
    },
    Request {
        path: String,
        source: Error,
    },
    Compress {
        path: String,
        source: Error,
    },
    Transport(Box<dyn Error + Send + Sync>),
}

Anything that can go wrong calling canopy.

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.

Http(CanopyHttpError)

Canopy answered with a status outside the success range.

Decode

The response body was not the JSON the endpoint declares.

Fields

path: String

Path that was called.

source: Error

Underlying serde error.

Encode

The request body could not be serialised.

Fields

path: String

Path that was called.

source: Error

Underlying serde error.

Request

Building the HTTP request failed.

Fields

path: String

Path that was called.

source: Error

Underlying http error.

Compress

Compressing the request body failed.

Fields

path: String

Path that was called.

source: Error

Underlying IO error.

Transport(Box<dyn Error + Send + Sync>)

The transport could not obtain any response.

Distinct from Error::Http, which is a response that reports failure.

Implementations

impl Error

pub fn transport<E: Error + Send + Sync + 'static>(err: E) -> Self

Wrap a transport-side failure to obtain a response.

pub fn http(&self) -> Option<&CanopyHttpError>

The CanopyHttpError this error carries, if it is one.

Endpoints give particular statuses meaning, so a caller branching on a documented status reads it through here.

pub fn status(&self) -> Option<StatusCode>

The status canopy answered with, if this is an unsuccessful response.

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

fn from(source: CanopyHttpError) -> Self

Converts to this type from the input type.