Struct git2::Patch

pub struct Patch<'buffers> { /* fields omitted */ }

A structure representing the text changes in a single diff delta.

This is an opaque structure.

Implementations

impl<'buffers> Patch<'buffers>

pub fn from_diff(
    diff: &Diff<'buffers>,
    idx: usize
) -> Result<Option<Self>, Error>

Return a Patch for one file in a Diff.

Returns Ok(None) for an unchanged or binary file.

pub fn from_blobs(
    old_blob: &Blob<'buffers>,
    old_path: Option<&Path>,
    new_blob: &Blob<'buffers>,
    new_path: Option<&Path>,
    opts: Option<&mut DiffOptions>
) -> Result<Self, Error>

Generate a Patch by diffing two blobs.

pub fn from_blob_and_buffer(
    old_blob: &Blob<'buffers>,
    old_path: Option<&Path>,
    new_buffer: &'buffers [u8],
    new_path: Option<&Path>,
    opts: Option<&mut DiffOptions>
) -> Result<Self, Error>

Generate a Patch by diffing a blob and a buffer.

pub fn from_buffers(
    old_buffer: &'buffers [u8],
    old_path: Option<&Path>,
    new_buffer: &'buffers [u8],
    new_path: Option<&Path>,
    opts: Option<&mut DiffOptions>
) -> Result<Self, Error>

Generate a Patch by diffing two buffers.

pub fn delta(&self) -> DiffDelta<'buffers>

Get the DiffDelta associated with the Patch.

pub fn num_hunks(&self) -> usize

Get the number of hunks in the Patch.

pub fn line_stats(&self) -> Result<(usize, usize, usize), Error>

Get the number of lines of context, additions, and deletions in the Patch.

pub fn hunk(
    &self,
    hunk_idx: usize
) -> Result<(DiffHunk<'buffers>, usize), Error>

Get a DiffHunk and its total line count from the Patch.

pub fn num_lines_in_hunk(&self, hunk_idx: usize) -> Result<usize, Error>

Get the number of lines in a hunk.

pub fn line_in_hunk(
    &self,
    hunk_idx: usize,
    line_of_hunk: usize
) -> Result<DiffLine<'buffers>, Error>

Get a DiffLine from a hunk of the Patch.

pub fn size(
    &self,
    include_context: bool,
    include_hunk_headers: bool,
    include_file_headers: bool
) -> usize

Get the size of a Patch's diff data in bytes.

pub fn print(
    &mut self,
    line_cb: &mut (dyn FnMut(DiffDelta<'_>, Option<DiffHunk<'_>>, DiffLine<'_>) -> bool + '_)
) -> Result<(), Error>

Print the Patch to text via a callback.

pub fn to_buf(&mut self) -> Result<Buf, Error>

Get the Patch text as a Buf.

Trait Implementations

impl<'buffers> Debug for Patch<'buffers>

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

Formats the value using the given formatter.

impl<'buffers> Drop for Patch<'buffers>

fn drop(&mut self)

Executes the destructor for this type.

impl<'buffers> Send for Patch<'buffers>