Struct dirty_tracker::DirtyTracker

pub struct DirtyTracker { /* private fields */ }

The tracker object.

This object keeps track of the dirty files in a directory.

The tracker is created with a path to a directory. It will watch for file system events in that directory and keep track of the files that have been modified.

The tracker can be in one of three states:

• Clean: No files have been modified.
• Dirty: Some files have been modified.
• Unknown: The tracker is in an unknown state. This can happen if the tracker has missed some events, or if the underlying file system is behaving in an unexpected way.

Implementations

impl DirtyTracker

pub fn new(path: &Path) -> Result<Self>

Create a new tracker object.

Arguments

• path - The path to the directory to watch.

Returns

A new DirtyTracker object.

pub fn mark_clean(&mut self)

Mark all files as clean.

Note that this can race with file modifications, so it’s only safe if you’re sure that no modifications are happening.

pub fn is_dirty(&mut self) -> bool

👎Deprecated since 0.2.0: Use state() instead

Returns true if there are dirty files.

pub fn state(&mut self) -> State

Returns the state of the tracker.

pub fn paths(&mut self) -> Option<&HashSet<PathBuf>>

Returns the paths of the dirty files.

If the tracker is in an unknown state, this will return None.

pub fn relpaths(&mut self) -> Option<HashSet<&Path>>

Returns the relative paths of the dirty files.

If the tracker is in an unknown state, this will return None.