Enum Error

#[non_exhaustive]
pub enum Error {
    CouldNotAccessUrl {
        url: Url,
        source: Box<Error>,
    },
    CouldNotGetOutput {
        name: String,
        source: Box<Error>,
    },
    CouldNotParseUrlWithDomain {
        domain: String,
        source: Box<ParseError>,
    },
    CouldNotReadFile {
        path: PathBuf,
        source: Box<Error>,
    },
    MissingEnvVar {
        var: String,
    },
    OutputNotAvailable {},
    PaymentRequired {
        url: Url,
        body: String,
    },
    Timeout {},
    UnexpectedHttpStatus {
        url: Url,
        status: StatusCode,
        body: String,
    },
    UnknownBigMlType {
        type_name: String,
    },
    WaitFailed {
        id: String,
        message: String,
    },
    WrongResourceType {
        expected: &'static str,
        found: String,
    },
    Other {
        source: Box<dyn StdError + Send + Sync + 'static>,
    },
}

A BigML-related error.

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.

CouldNotAccessUrl

We could not access the specified URL.

WARNING: Do not construct this directly, but use Error::could_not_access_url to handle various URL sanitization and security issues.

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.

url: Url

source: Box<Error>

CouldNotGetOutput

We could not get an output value from a WhizzML script.

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.

name: String

source: Box<Error>

CouldNotParseUrlWithDomain

We could not parse the specified URL.

WARNING: This takes a domain, not the full URL that we couldn’t parse, because we want to be careful to exclude credentials from error messages, and we can’t remove credentials from a URL we can’t parse.

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.

domain: String

source: Box<ParseError>

CouldNotReadFile

We could not read a file.

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.

path: PathBuf

source: Box<Error>

MissingEnvVar

The user must specify the environment variable var.

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.

var: String

OutputNotAvailable

We could not access an output value of a WhizzML script.

PaymentRequired

BigML says that payment is required for this request, perhaps because we have hit plan limits.

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.

url: Url

body: String

Timeout

A request timed out.

UnexpectedHttpStatus

We received an unexpected HTTP status code.

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.

url: Url

status: StatusCode

body: String

UnknownBigMlType

We encountered an unknown BigML value type.

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.

type_name: String

WaitFailed

We tried to create a BigML resource, but we failed. Display a dashboard URL to make it easy to look up the actual error.

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.

id: String

The ID of the resource that we were waiting on.

message: String

The message that was returned.

WrongResourceType

We found a type mismatch deserializing a BigML resource ID.

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.

expected: &'static str

found: String

Other

Another kind of error occurred.

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.

source: Box<dyn StdError + Send + Sync + 'static>

The original error.

We add Send + Sync to make it easy to use in the presence of threads, and 'static to make sure it depends on no borrowed data.

Implementations

impl Error

pub fn might_be_temporary(&self) -> bool

Is this error likely to be temporary?

pub fn original_bigml_error(&self) -> &Error

Return the original bigml::Error that caused this error, without any wrapper errors.

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<Box<dyn Error + Sync + Send>> for Error

fn from(source: Box<dyn StdError + Send + Sync + 'static>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Error

Converts to this type from the input type.

impl<T> From<Error> for WaitStatus<T, Error>

fn from(error: Error) -> Self

Convert an Error to either WaitStatus::FailedTemporarily or WaitStatus::FailedPermanently depending on Error::might_be_temporary.