Enum rocket::config::ConfigError

pub enum ConfigError {
    NotFound,
    IoError,
    Io(Error, &'static str),
    BadFilePath(PathBuf, &'static str),
    BadEnv(String),
    BadEntry(String, PathBuf),
    BadType(String, &'static str, &'static str, Option<PathBuf>),
    ParseError(String, PathBuf, String, Option<(usize, usize)>),
    BadEnvVal(String, String, String),
    UnknownKey(String),
    Missing(String),
}

The type of a configuration error.

Variants

NotFound

The configuration file was not found.

IoError

There was an I/O error while reading the configuration file.

Io(Error, &'static str)

There was an I/O error while setting a configuration parameter.

Parameters: (io_error, config_param_name)

Tuple Fields of Io

0: Error1: &'static str

BadFilePath(PathBuf, &'static str)

The path at which the configuration file was found was invalid.

Parameters: (path, reason)

Tuple Fields of BadFilePath

0: PathBuf1: &'static str

BadEnv(String)

An environment specified in ROCKET_ENV is invalid.

Parameters: (environment_name)

Tuple Fields of BadEnv

0: String

BadEntry(String, PathBuf)

An environment specified as a table [environment] is invalid.

Parameters: (environment_name, filename)

Tuple Fields of BadEntry

0: String1: PathBuf

BadType(String, &'static str, &'static str, Option<PathBuf>)

A config key was specified with a value of the wrong type.

Parameters: (entry_name, expected_type, actual_type, filename)

Tuple Fields of BadType

0: String1: &'static str2: &'static str3: Option<PathBuf>

ParseError(String, PathBuf, String, Option<(usize, usize)>)

There was a TOML parsing error.

Parameters: (toml_source_string, filename, error_description, line/col)

Tuple Fields of ParseError

0: String1: PathBuf2: String3: Option<(usize, usize)>

BadEnvVal(String, String, String)

There was a TOML parsing error in a config environment variable.

Parameters: (env_key, env_value, error)

Tuple Fields of BadEnvVal

0: String1: String2: String

UnknownKey(String)

The entry (key) is unknown.

Parameters: (key)

Tuple Fields of UnknownKey

0: String

Missing(String)

The entry (key) was expected but was missing.

Parameters: (key)

Tuple Fields of Missing

0: String

Implementations

impl ConfigError

pub fn pretty_print(&self)

Prints this configuration error with Rocket formatting.

pub fn is_not_found(&self) -> bool

Returns true if self is of NotFound variant.

Example

use rocket::config::ConfigError;

let error = ConfigError::NotFound;
assert!(error.is_not_found());

Trait Implementations

impl Debug for ConfigError

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

Formats the value using the given formatter.

impl Display for ConfigError

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

Formats the value using the given formatter.

impl Error for ConfigError

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<ConfigError> for ConfigError

fn eq(&self, other: &ConfigError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.