Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    DuplicateContentFile {
        file: String,
        config_path: PathBuf,
        line: Option<usize>,
    },
    DuplicateArchiveFile {
        file: String,
        config_path: PathBuf,
        line: Option<usize>,
    },
    CannotAddContentFile {
        file: String,
        config_path: PathBuf,
    },
    CannotAddArchiveFile {
        file: String,
        config_path: PathBuf,
    },
    DuplicateGroundcoverFile {
        file: String,
        config_path: PathBuf,
        line: Option<usize>,
    },
    CannotAddGroundcoverFile {
        file: String,
        config_path: PathBuf,
    },
    InvalidGameSetting {
        value: String,
        config_path: PathBuf,
        line: Option<usize>,
    },
    BadEncoding {
        value: String,
        config_path: PathBuf,
        line: Option<usize>,
    },
    InvalidLine {
        value: String,
        config_path: PathBuf,
        line: Option<usize>,
    },
    Io(Error),
    NotFileOrDirectory(PathBuf),
    CannotFind(PathBuf),
    CannotFindRootConfig {
        local: PathBuf,
        global: PathBuf,
    },
    CannotFindAnyConfig {
        local: PathBuf,
        global: PathBuf,
        user: PathBuf,
    },
    NotWritable(PathBuf),
    SubconfigNotLoaded(PathBuf),
    MaxDepthExceeded(PathBuf),
    PlatformPathUnavailable(&'static str),
}

Errors that can arise while loading, mutating, or saving an OpenMW configuration.

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.

DuplicateContentFile

A content file (content=) appeared twice in the configuration chain.

Fields

file: String

config_path: PathBuf

line: Option<usize>

DuplicateArchiveFile

A fallback-archive (fallback-archive=) appeared twice in the configuration chain.

Fields

file: String

config_path: PathBuf

line: Option<usize>

CannotAddContentFile

OpenMWConfiguration::add_content_file was called for a file that is already present.

Fields

file: String

config_path: PathBuf

CannotAddArchiveFile

OpenMWConfiguration::add_archive_file was called for an archive that is already present.

Fields

file: String

config_path: PathBuf

DuplicateGroundcoverFile

A groundcover file (groundcover=) appeared twice in the configuration chain.

Fields

file: String

config_path: PathBuf

line: Option<usize>

CannotAddGroundcoverFile

OpenMWConfiguration::add_groundcover_file was called for a file that is already present.

Fields

file: String

config_path: PathBuf

InvalidGameSetting

A fallback= entry could not be parsed as a valid Key,Value pair.

Fields

value: String

config_path: PathBuf

line: Option<usize>

BadEncoding

An encoding= entry contained an unrecognised encoding name. Only win1250, win1251, and win1252 are valid.

Fields

value: String

config_path: PathBuf

line: Option<usize>

InvalidLine

A line in an openmw.cfg file did not match any recognised key=value format.

Fields

value: String

config_path: PathBuf

line: Option<usize>

Io(Error)

An I/O error occurred while reading or writing a config file.

NotFileOrDirectory(PathBuf)

The supplied path could not be classified as a file or directory.

CannotFind(PathBuf)

No openmw.cfg was found at the given path.

CannotFindRootConfig

Root config discovery tried both local and global config candidates and found neither. global is empty on platforms without a global config directory (Windows, macOS).

Fields

local: PathBuf

global: PathBuf

CannotFindAnyConfig

External-tool config discovery found neither root nor user config candidates. global is empty on platforms without a global config directory (Windows, macOS).

Fields

local: PathBuf

global: PathBuf

user: PathBuf

NotWritable(PathBuf)

The target path for a save operation is not writable.

SubconfigNotLoaded(PathBuf)

OpenMWConfiguration::save_subconfig was called with a path that is not part of the loaded configuration chain.

MaxDepthExceeded(PathBuf)

The config= chain nests more than 16 levels below the root. A chain that loops does not get here: a directory the chain already tried is skipped, as OpenMW skips it.

PlatformPathUnavailable(&'static str)

A platform default path could not be determined, because the environment or the operating system gave none: HOME unset or empty, no Documents known folder, or a platform OpenMW has no such path on. The string names the path: home, documents, config, userdata, local, global or global_config.

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

fn from(err: Error) -> Self

Converts to this type from the input type.