Enum ConfigError

pub enum ConfigError {
    InvalidFileEncoding(Error, PathBuf),
    IoError(Error),
    DataParseError(DataParseError),
    UnknownFormat(UnknownFormatError),
}

The main result error type of the crate.
Each type has it’s own documentation.

Variants

InvalidFileEncoding(Error, PathBuf)

Occurs when a file isn’t composed of valid UTF-8 characters.

• Stores the path to the erroring file

IoError(Error)

Occurs when the file could not be saved due to filesystem-related errors.
Usually when one of the parent directories for the config file could not be located or automatically created.

• Stores the std::io::Error in question

DataParseError(DataParseError)

Occurs when Serde fails to serialize/deserialize your data

• Stores an enum containing the section of data parsing failed for (serialization/deserialization)
  

UnknownFormat(UnknownFormatError)

Occurs when fast_config cannot guess what format your data should be.

• Stores some data related to the error

This error can be avoided by either:

1. Adding a file extension at the end of the path name (json/json5, toml, yaml/yml)
   (It would be appreciated if you create an issue on the project’s Github if you notice an extension type is missing)
2. Passing a ConfigSetupOptions struct into Config::from_options, and defining the format there.
3. Or only having one enabled format feature in your cargo.toml

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ConfigError

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<DataParseError> for ConfigError

fn from(item: DataParseError) -> Self

Converts to this type from the input type.

impl From<Error> for ConfigError

fn from(item: Error) -> Self

Converts to this type from the input type.