Enum git_checks_core::impl_prelude::GitError

#[non_exhaustive]
pub enum GitError {
    Subcommand {
        subcommand: &'static str,
        source: Error,
    },
    Git {
        msg: Cow<'static, str>,
        source: Option<Error>,
    },
    InvalidRef {
        ref_: Cow<'static, str>,
    },
}

Errors which may occur when working with workareas.

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.

Subcommand

Fields

subcommand: &'static str

The git subcommand which failed.

source: Error

The root cause of the failure.

Command preparation failure.

Git

Fields

msg: Cow<'static, str>

Message describing what failed.

source: Option<Error>

The root cause of the failure (if available).

A git error occurred.

InvalidRef

Fields

ref_: Cow<'static, str>

The invalid ref (or description of what was wrong).

An invalid ref was used.

Implementations

impl GitError

pub fn subcommand(subcommand: &'static str, source: Error) -> GitError

Convenience method for constructing an error for a git subcommand failure.

Trait Implementations

impl Debug for GitError

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

Formats the value using the given formatter.

impl Display for GitError

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

Formats the value using the given formatter.

impl Error for GitError

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

impl From<GitError> for CommitError

fn from(source: GitError) -> Self

Performs the conversion.

impl From<GitError> for AttributeError

fn from(source: GitError) -> Self

Performs the conversion.

impl From<GitError> for RunError

fn from(source: GitError) -> Self

Performs the conversion.