Enum VCSError

#[non_exhaustive]
pub enum VCSError {
    NoVCS,
    NotAllowedFilesFound {
        dirty_files: Vec<String>,
        staged_files: Vec<String>,
    },
    GitError(Error),
    Anyhow(Error),
}

Enumerates the possible error values that can be generated by this crate

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.

NoVCS

Unable to detect a version control system

NotAllowedFilesFound

Found a type of file that was not allowed. Includes listing of disallowed files found

Fields

dirty_files: Vec<String>

Dirty files found (note this will be empty if dirty files are allowed)

staged_files: Vec<String>

Staged files found (note this will be empty if staged files are allowed)

GitError(Error)

Errors from the git2 library

Anyhow(Error)

Errors that were wrapped in anyhow by cargo_utils

Trait Implementations

impl Debug for VCSError

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

Formats the value using the given formatter.

impl Display for VCSError

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

Formats the value using the given formatter.

impl Error for VCSError

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<Error> for VCSError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for VCSError

fn from(source: Error) -> Self

Converts to this type from the input type.