Struct RepositoryChanges 

pub struct RepositoryChanges { /* private fields */ }

A non-empty set of file changes.

Values of this type are returned by Repository::repository_changes and Repository::path_changes.

This type contains only dirty and/or staged files. Dirty files have unstaged modifications or are untracked. Clean tracked files are not included. Files ignored by the VCS are also omitted because this crate is intended for --allow-* style checks, which treat them the same as clean files.

Repository::repository_changes and Repository::path_changes return None instead of an empty change set.

File changes are ordered by ascending worktree-relative path. Entries may include tracked paths that are no longer present in the worktree.

Implementations

impl RepositoryChanges

pub fn files(&self) -> Files<'_>

Returns an iterator over all file changes in this change set.

Files are yielded in ascending worktree-relative path order.

pub fn dirty_files(&self) -> DirtyFiles<'_>

Returns an iterator over dirty files in this change set.

A dirty file has unstaged modifications or is untracked. Staged-only changes are not considered dirty. Files are yielded in ascending worktree-relative path order.

pub fn staged_files(&self) -> StagedFiles<'_>

Returns an iterator over files with staged changes in this change set.

Files are yielded in ascending worktree-relative path order.

pub fn has_dirty_files(&self) -> bool

Returns whether this change set contains any dirty files.

A dirty file has unstaged modifications or is untracked. Staged-only changes are not considered dirty.

pub fn has_staged_files(&self) -> bool

Returns whether this change set contains any files with staged changes.

Trait Implementations

impl Clone for RepositoryChanges

fn clone(&self) -> RepositoryChanges

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RepositoryChanges

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

Formats the value using the given formatter.