Struct git2::Diff

pub struct Diff<'repo> { /* private fields */ }

The diff object that contains all individual file deltas.

This is an opaque structure which will be allocated by one of the diff generator functions on the Repository structure (e.g. diff_tree_to_tree or other diff_* functions).

Implementations

impl<'repo> Diff<'repo>

pub fn merge(&mut self, from: &Diff<'repo>) -> Result<(), Error>

Merge one diff into another.

This merges items from the “from” list into the “self” list. The resulting diff will have all items that appear in either list. If an item appears in both lists, then it will be “merged” to appear as if the old version was from the “onto” list and the new version is from the “from” list (with the exception that if the item has a pending DELETE in the middle, then it will show as deleted).

pub fn deltas(&self) -> Deltas<'_>

Returns an iterator over the deltas in this diff.

pub fn get_delta(&self, i: usize) -> Option<DiffDelta<'_>>

Return the diff delta for an entry in the diff list.

pub fn is_sorted_icase(&self) -> bool

Check if deltas are sorted case sensitively or insensitively.

pub fn print<F>(&self, format: DiffFormat, cb: F) -> Result<(), Error> where
    F: FnMut(DiffDelta<'_>, Option<DiffHunk<'_>>, DiffLine<'_>) -> bool, 

Iterate over a diff generating formatted text output.

Returning false from the callback will terminate the iteration and return an error from this function.

pub fn foreach(
    &self,
    file_cb: &mut (dyn FnMut(DiffDelta<'_>, f32) -> bool + '_),
    binary_cb: Option<&mut (dyn FnMut(DiffDelta<'_>, DiffBinary<'_>) -> bool + '_)>,
    hunk_cb: Option<&mut (dyn FnMut(DiffDelta<'_>, DiffHunk<'_>) -> bool + '_)>,
    line_cb: Option<&mut (dyn FnMut(DiffDelta<'_>, Option<DiffHunk<'_>>, DiffLine<'_>) -> bool + '_)>
) -> Result<(), Error>

Loop over all deltas in a diff issuing callbacks.

Returning false from any callback will terminate the iteration and return an error from this function.

pub fn stats(&self) -> Result<DiffStats, Error>

Accumulate diff statistics for all patches.

pub fn find_similar(
    &mut self,
    opts: Option<&mut DiffFindOptions>
) -> Result<(), Error>

Transform a diff marking file renames, copies, etc.

This modifies a diff in place, replacing old entries that look like renames or copies with new entries reflecting those changes. This also will, if requested, break modified files into add/remove pairs if the amount of change is above a threshold.

pub fn format_email(
    &mut self,
    patch_no: usize,
    total_patches: usize,
    commit: &Commit<'repo>,
    opts: Option<&mut DiffFormatEmailOptions>
) -> Result<Buf, Error>

Create an e-mail ready patch from a diff.

Matches the format created by git format-patch

pub fn patchid(
    &self,
    opts: Option<&mut DiffPatchidOptions>
) -> Result<Oid, Error>

Create an patchid from a diff.

impl Diff<'static>

pub fn from_buffer(buffer: &[u8]) -> Result<Diff<'static>, Error>

Read the contents of a git patch file into a git_diff object.

The diff object produced is similar to the one that would be produced if you actually produced it computationally by comparing two trees, however there may be subtle differences. For example, a patch file likely contains abbreviated object IDs, so the object IDs parsed by this function will also be abreviated.

Trait Implementations

impl<'repo> Drop for Diff<'repo>

fn drop(&mut self)

Executes the destructor for this type.

impl<'repo> Send for Diff<'repo>