Enum git_checks_core::impl_prelude::CommitError

#[non_exhaustive]
pub enum CommitError {
    Git {
        source: GitError,
    },
    FileName {
        source: FileNameError,
    },
    CommitMetadata {
        ref_: CommitId,
        output: String,
    },
    CommitMetadataOutput {
        output: String,
    },
    CommitMessage {
        ref_: CommitId,
        output: String,
    },
    RevList {
        base_rev: CommitId,
        merge_base: Option<CommitId>,
        output: String,
    },
    AncestorCheck {
        best_rev: CommitId,
        merge_base: CommitId,
        output: String,
    },
    MergeBase {
        base: CommitId,
        head: CommitId,
        output: String,
    },
    DiffTree {
        commit: CommitId,
        base: Option<CommitId>,
        output: String,
    },
    DiffPatch {
        commit: CommitId,
        base: Option<CommitId>,
        path: PathBuf,
        output: String,
    },
}

Errors which can occur when working with a commit for a check.

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.

Git

Fields

source: GitError

The cause of the error.

Command preparation failure.

FileName

Fields

source: FileNameError

The cause of the error.

File name parsing failure.

CommitMetadata

Fields

ref_: CommitId

The commit that was being queried.

output: String

Git’s output for the error.

Failure to extract commit metadata.

CommitMetadataOutput

Fields

output: String

Git’s actual output.

The commit metadata output did not match the expected format.

CommitMessage

Fields

ref_: CommitId

The commit that was being queried.

output: String

Git’s output for the error.

Failure to extract commit message.

RevList

Fields

base_rev: CommitId

The commit being queried.

merge_base: Option<CommitId>

The merge base being tested.

output: String

Git’s output for the error.

Failure to list revisions in a branch.

AncestorCheck

Fields

best_rev: CommitId

The commit being queried.

merge_base: CommitId

The merge base being tested.

output: String

Git’s output for the error.

Failure to check the ancestory in a branch.

MergeBase

Fields

base: CommitId

The base commit.

head: CommitId

The head of the topic.

output: String

Git’s output for the error.

Failure to determine the merge base between two commits.

DiffTree

Fields

commit: CommitId

The commit being queried.

base: Option<CommitId>

The “old” commit of the branch (the parent of the commit if not set).

output: String

Git’s output for the error.

Failure to tree diff of a commit.

DiffPatch

Fields

commit: CommitId

The commit being queried.

base: Option<CommitId>

The “old” commit of the branch (the parent of the commit if not set).

path: PathBuf

The path being queried.

output: String

Git’s output for the error.

Failure to get the patch of a commit.

Trait Implementations

impl Debug for CommitError

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

Formats the value using the given formatter.

impl Display for CommitError

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

Formats the value using the given formatter.

impl Error for CommitError

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<CommitError> for RunError

fn from(source: CommitError) -> Self

Performs the conversion.

impl From<FileNameError> for CommitError

fn from(source: FileNameError) -> Self

Performs the conversion.

impl From<GitError> for CommitError

fn from(source: GitError) -> Self

Performs the conversion.