Struct git_repository::config::key::Error

pub struct Error<E: Error + Send + Sync + 'static, const PREFIX: char, const SUFFIX: char> {
    pub key: BString,
    pub value: Option<BString>,
    pub environment_override: Option<&'static str>,
    pub source: Option<E>,
}

A generic error suitable to produce decent messages for all kinds of configuration errors with config-key granularity.

This error is meant to be reusable and help produce uniform error messages related to parsing any configuration key.

Fields

key: BString

The configuration key that contained the value.

value: Option<BString>

The value that was assigned to key.

environment_override: Option<&'static str>

The associated environment variable that would override this value.

source: Option<E>

The source of the error if there was one.

Implementations

impl<E, const PREFIX: char, const SUFFIX: char> Error<E, PREFIX, SUFFIX>where E: Error + Send + Sync + 'static,

Initialization

pub fn from_value(key: &'static impl Key, value: BString) -> Self

Instantiate an error with all data from key along with the value of the key.

impl<E, const PREFIX: char, const SUFFIX: char> Error<E, PREFIX, SUFFIX>where E: Error + Send + Sync + 'static,

Builder

pub fn with_source(self, err: E) -> Self

Attach the given err as source.

pub fn with_value(self, value: BString) -> Self

Attach the given value as value we observed when the error was produced.

Trait Implementations

impl<E: Debug + Error + Send + Sync + 'static, const PREFIX: char, const SUFFIX: char> Debug for Error<E, PREFIX, SUFFIX>

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

Formats the value using the given formatter.

impl<E: Error + Send + Sync + 'static, const PREFIX: char, const SUFFIX: char> Display for Error<E, PREFIX, SUFFIX>

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

Formats the value using the given formatter.

impl<E, const PREFIX: char, const SUFFIX: char> Error for Error<E, PREFIX, SUFFIX>where E: Error + 'static + Send + Sync, Self: Debug + Display,

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

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, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl<T, E, const PREFIX: char, const SUFFIX: char> From<&'static T> for Error<E, PREFIX, SUFFIX>where E: Error + Send + Sync + 'static, T: Key,

Initialization Instantiate a new error from the given key.

Note that specifics of the error message are defined by the PREFIX and SUFFIX which is usually defined by a typedef.

fn from(key: &'static T) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'b', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'b', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'b', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'd', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'i', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'k', 'i'>> for Error

fn from(source: GenericError) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'k', 'i'>> for Error

Available on crate features async-network-client or blocking-network-client only.

fn from(source: GenericError) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'k', 'u'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'k', 'u'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'k', 'u'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'k', 'u'>> for Error

Available on crate features async-network-client or blocking-network-client only.

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'n', 'd'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 't', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 't', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'v', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'v', 'i'>> for Error

fn from(source: GenericErrorWithValue) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'v', 'i'>> for Error

fn from(source: GenericErrorWithValue) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'v', 'i'>> for Error

fn from(source: GenericErrorWithValue) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'v', 'i'>> for Error

fn from(source: GenericErrorWithValue) -> Self

Converts to this type from the input type.

impl From<Error<Error, 'v', 'i'>> for Error

fn from(source: GenericErrorWithValue) -> Self

Converts to this type from the input type.

impl From<Error<Infallible, 's', 'i'>> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.