Enum git_workarea::GitError

pub enum GitError {
    Subcommand {
        subcommand: &'static str,
        source: Error,
    },
    Git {
        msg: Cow<'static, str>,
        source: Option<Error>,
    },
    InvalidRef {
        ref_: Cow<'static, str>,
    },
    // some variants omitted
}

Errors which may occur when working with workareas.

This enum is non_exhaustive, but cannot be marked as such until it is stable. In the meantime, there is a hidden variant.

Variants

Subcommand

Command preparation failure.

Fields of Subcommand

subcommand: &'static str

The git subcommand which failed.

source: Error

The root cause of the failure.

Git

A git error occurred.

Fields of Git

msg: Cow<'static, str>

Message describing what failed.

source: Option<Error>

The root cause of the failure (if available).

InvalidRef

An invalid ref was used.

Fields of InvalidRef

ref_: Cow<'static, str>

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

Methods

impl GitError

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

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

Trait Implementations

impl From<GitError> for WorkAreaError

fn from(source: GitError) -> Self

Performs the conversion.

impl Display for GitError

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Debug for GitError

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

Formats the value using the given formatter.

impl Error for GitError

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

The lower-level source of this error, if any.

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause 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 ocurred.