gix_diff/tree_with_rewrites/mod.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
use crate::tree::recorder::Location;
use crate::Rewrites;
mod change;
pub use change::{Change, ChangeRef};
/// The error returned by [`tree_with_rewrites()`](super::tree_with_rewrites()).
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error(transparent)]
Diff(#[from] crate::tree::Error),
#[error("The user-provided callback failed")]
ForEach(#[source] Box<dyn std::error::Error + Send + Sync + 'static>),
#[error("Failure during rename tracking")]
RenameTracking(#[from] crate::rewrites::tracker::emit::Error),
}
/// Returned by the [`tree_with_rewrites()`](super::tree_with_rewrites()) function to control flow.
#[derive(Default, Clone, Copy, PartialOrd, PartialEq, Ord, Eq, Hash)]
pub enum Action {
/// Continue the traversal of changes.
#[default]
Continue,
/// Stop the traversal of changes and stop calling the function that returned it.
Cancel,
}
/// Options for use in [`tree_with_rewrites()`](super::tree_with_rewrites()).
#[derive(Default, Clone, Debug)]
pub struct Options {
/// Determine how locations of changes, i.e. their repository-relative path, should be tracked.
/// If `None`, locations will always be empty.
pub location: Option<Location>,
/// If not `None`, rename tracking will be performed accordingly.
pub rewrites: Option<Rewrites>,
}
pub(super) mod function;