Enum GatewayConfigError 

#[non_exhaustive]
pub enum GatewayConfigError {
    MissingEnv(String),
    InvalidEnv(String),
    InvalidConfig(String),
    Config {
        message: String,
        source: Box<dyn Error + Send + Sync>,
    },
}

The error returned when setting up the gateway client fails because an environment variable, the bearer key, or the endpoint URL is missing or unusable.

This is a setup error. It happens before the client sends its first request, so it stays within client setup, separate from the Engine and its CompletionErrorKind values. The message names the environment variable or the rule that failed, and never contains a key.

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.

MissingEnv(String)

A required environment variable was missing.

InvalidEnv(String)

An environment variable was set, but its value was invalid Unicode.

InvalidConfig(String)

A configuration value failed validation.

Config

A configuration input was invalid, and the error keeps the concrete cause as its source.

The cause is, for example, a URL parse failure or an unusable secret.

Fields

message: String

A human-readable description of the problem. The text of the source error appears only in source.

source: Box<dyn Error + Send + Sync>

The underlying error that caused this one.

Trait Implementations

impl Debug for GatewayConfigError

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

Formats the value using the given formatter.

impl Display for GatewayConfigError

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

Formats the value using the given formatter.

impl Error for GatewayConfigError

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<SecretError> for GatewayConfigError

fn from(error: SecretError) -> GatewayConfigError

Converts to this type from the input type.