Enum ConfigError 

#[non_exhaustive]
pub enum ConfigError {
    BadConfigLine {
        location: String,
        line: usize,
    },
    BadConfigLineInFile {
        file: String,
        line: usize,
    },
    MissingValue {
        key: String,
    },
    BadConfigVariable {
        key: String,
        file: String,
        line: usize,
    },
    KeyNotSet {
        key: String,
    },
    BadNumericValue {
        key: String,
        value: String,
        reason: BadNumericSource,
    },
    BadNumericValueInFile {
        key: String,
        value: String,
        file: String,
        reason: BadNumericSource,
    },
    BadConfigVariableAtLine {
        key: String,
        file: String,
        line: usize,
    },
    UnableToParseFromCommandLine {
        key: String,
    },
    RemoteUrlInHasconfigInclude,
    IncludeDepthExceeded {
        depth: usize,
        limit: usize,
    },
    Other(String),
    ConfigFileLocked {
        path: String,
    },
    MultipleValues {
        key: String,
    },
    WorktreeConfigNotEnabled,
    SectionNotFound {
        section: String,
    },
    MultilineCommentNotAllowed,
    InvalidUntrackedFilesMode {
        value: String,
    },
}

Configuration parse and validation failures.

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.

BadConfigLine

A line in a config file could not be parsed.

Fields

location: String

Config source label or path where the error was detected.

line: usize

One-based line number within that source.

BadConfigLineInFile

Same as Self::BadConfigLine with an explicit file path (Git file diagnostics).

Fields

file: String

Path to the config file involved in the error.

line: usize

One-based line number within that file.

MissingValue

A config key requires a value but none was given.

Fields

key: String

Config key name that failed validation.

BadConfigVariable

fetch.negotiationalgorithm and similar keys with missing values.

Fields

key: String

Config key name that failed validation.

file: String

Path to the config file involved in the error.

line: usize

One-based line number within the config source.

KeyNotSet

unset or a scoped read/write was requested for a key that is not set in that file.

Fields

key: String

Config key that was not present.

BadNumericValue

Integer config value could not be parsed or is out of range.

Fields

key: String

Config key name that failed validation.

value: String

Raw config value that could not be parsed.

reason: BadNumericSource

Why the value or operation was rejected.

BadNumericValueInFile

Same as Self::BadNumericValue with file context.

Fields

key: String

Config key name that failed validation.

value: String

Raw config value that could not be parsed.

file: String

Path to the config file involved in the error.

reason: BadNumericSource

Why the value or operation was rejected.

BadConfigVariableAtLine

diff.context (or similar) failed variable validation.

Fields

key: String

Config key name that failed validation.

file: String

Path to the config file involved in the error.

line: usize

One-based line number within the config source.

UnableToParseFromCommandLine

Command-line config could not supply a parseable value for a key.

Fields

key: String

Config key name that failed validation.

RemoteUrlInHasconfigInclude

includeIf.hasconfig:remote.*.url cannot pull remote URLs from included files.

IncludeDepthExceeded

[include] / [includeIf] nesting exceeded the Git-compatible depth limit.

Fields

depth: usize

Current include nesting depth when the limit was hit.

limit: usize

Maximum allowed include nesting depth.

Other(String)

Generic config error with free-form detail (legacy call sites).

ConfigFileLocked

The config file could not be written because a .lock file is already present.

Fields

path: String

Path to the config file that could not be locked.

MultipleValues

A single-value operation was requested but the key has multiple values.

Fields

key: String

Config key name that failed validation.

WorktreeConfigNotEnabled

Per-worktree config was requested but extensions.worktreeConfig is off.

SectionNotFound

remove-section or rename-section did not find the named section.

Fields

section: String

Section header name (e.g. remote.origin).

MultilineCommentNotAllowed

Inline --comment text must not span lines.

InvalidUntrackedFilesMode

status.showUntrackedFiles must be no, normal, all, or a Git boolean synonym.

Fields

value: String

Raw config value that could not be parsed.

Implementations

impl ConfigError

pub fn message_body(&self) -> String

Git stderr body for this error (without a fatal: prefix).

Trait Implementations

impl Clone for ConfigError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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<&str> for ConfigError

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<ConfigError> for Error

fn from(source: ConfigError) -> Self

Converts to this type from the input type.

impl From<String> for ConfigError

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for ConfigError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConfigError