Enum Error 

#[non_exhaustive]
pub enum Error {
    Http(HttpError),
    #[non_exhaustive]
    Status {
        code: u16,
        body: String,
    },
    Unauthorized,
    Forbidden,
    #[non_exhaustive]
    RateLimited {
        retry_after: Option<Duration>,
    },
    Unauthenticated,
    Deserialize(Error),
    Io(Error),
    Utf8(FromUtf8Error),
    #[non_exhaustive]
    Oauth {
        error: String,
        description: Option<String>,
    },
}

Errors returned by this crate.

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(HttpError)

Transport-level failure (DNS, TLS, connection, timeout).

#[non_exhaustive]

Status

Non-2xx response that does not map to a more specific variant.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

code: u16

The HTTP status code.

body: String

The response body, for diagnosis. May be empty.

Unauthorized

401 Unauthorized from the API.

Forbidden

403 Forbidden from the API.

#[non_exhaustive]

RateLimited

429 Too Many Requests. retry_after is set if the server sent Retry-After.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

retry_after: Option<Duration>

How long the server asked you to wait, if it sent Retry-After.

Unauthenticated

An API call was made on a client with no access token (and no refresh token to mint one). Every TONE3000 endpoint requires a Bearer access token.

Deserialize(Error)

Response body could not be deserialized.

Io(Error)

Failure writing a streamed download to the provided writer.

Utf8(FromUtf8Error)

A downloaded body was expected to be UTF-8 text (e.g. .nam JSON) but was not.

#[non_exhaustive]

Oauth

OAuth token endpoint returned an error body.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

error: String

The machine-readable OAuth error code, e.g. invalid_grant.

description: Option<String>

The server’s human-readable explanation, when it sent one.

Implementations

impl Error

pub fn is_timeout(&self) -> bool

The request timed out.

pub fn is_connect(&self) -> bool

The failure happened while establishing the connection.

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

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<HttpError> for Error

fn from(source: HttpError) -> Self

Converts to this type from the input type.