Struct git_repository::object::tree::diff::Platform

pub struct Platform<'a, 'repo> { /* private fields */ }

The diffing platform returned by Tree::changes().

Implementations

impl<'a, 'old> Platform<'a, 'old>

Add the item to compare to.

pub fn for_each_to_obtain_tree<'new, E>( &mut self, other: &Tree<'new>, for_each: impl FnMut(Change<'_, 'old, 'new>) -> Result<Action, E> ) -> Result<(), Error>where E: Error + Sync + Send + 'static,

Call for_each repeatedly with all changes that are needed to convert the source of the diff to the tree to other.

other could also be created with the empty_tree() method to handle the first commit in a repository - it doesn’t have a parent, equivalent to compare ‘nothing’ to something.

impl<'a, 'repo> Platform<'a, 'repo>

Configuration

pub fn track_filename(&mut self) -> &mut Self

Keep track of file-names, which makes the location field usable with the filename of the changed item.

pub fn track_path(&mut self) -> &mut Self

Keep track of the entire path of a change, relative to the repository.

This makes the location field usable.

pub fn track_renames(&mut self, renames: Option<Renames>) -> &mut Self

Provide None to disable rename tracking entirely, or pass Some(<configuration>) to control to what extend rename tracking is performed.

Note that by default, the configuration determines rename tracking and standard git defaults are used if nothing is configured, which turns on rename tracking with -M50%.

Trait Implementations

impl<'a, 'repo> Clone for Platform<'a, 'repo>

fn clone(&self) -> Platform<'a, 'repo>

Returns a copy of the value.

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

Performs copy-assignment from source.