Enum UnsafeModificationReason 

#[non_exhaustive]
pub enum UnsafeModificationReason {
    NoVcs,
    Dirty {
        worktree: PathBuf,
        dirty_files: Vec<PathBuf>,
        staged_files: Vec<PathBuf>,
    },
    Staged {
        worktree: PathBuf,
        staged_files: Vec<PathBuf>,
    },
}

The reason modification of the queried target is considered unsafe under the current --allow-* policy.

This type explains why ModificationSafety::Unsafe was returned.

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

Modification is considered unsafe because no supported VCS repository was found for the queried target.

Dirty

Modification is considered unsafe because dirty files were found.

staged_files is non-empty only when staged changes also make the modification unsafe.

Fields

worktree: PathBuf

The root directory of the containing repository worktree.

dirty_files: Vec<PathBuf>

Worktree-relative paths of dirty files that make the modification unsafe.

This includes modified and untracked files.

staged_files: Vec<PathBuf>

Worktree-relative paths of staged files that also make the modification unsafe.

Staged

Modification is considered unsafe because staged changes were found.

Fields

worktree: PathBuf

The root directory of the containing repository worktree.

staged_files: Vec<PathBuf>

Worktree-relative paths of staged files that make the modification unsafe.

Trait Implementations

impl Debug for UnsafeModificationReason

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

Formats the value using the given formatter.

impl From<UnsafeModificationReason> for ModificationSafety

fn from(reason: UnsafeModificationReason) -> Self

Converts to this type from the input type.