Skip to main content

DiffDocument

Struct DiffDocument 

Source
pub struct DiffDocument {
    pub commit: Option<CommitHeader>,
    pub files: Vec<FileDiff>,
}
Expand description

A complete unified diff document.

Fields§

§commit: Option<CommitHeader>

Commit preamble before the first diff --git section, if present.

§files: Vec<FileDiff>

File diffs in input order.

Implementations§

Source§

impl DiffDocument

Source

pub fn is_empty(&self) -> bool

Returns whether the document contains no changed files.

Source

pub fn stats(&self) -> Stats

Returns the totals of files changed, insertions, and deletions.

Source§

impl DiffDocument

Source

pub fn for_hunks(file: &FileDiff, hunks: impl IntoIterator<Item = Hunk>) -> Self

Returns a single-file document with the given hunks, suitable for git apply. The preamble is dropped.

Source

pub fn split_hunks(self) -> Self

Splits multi-change hunks into independently reviewable hunks.

Hunk ids are reassigned sequentially across the whole document, so the split must run before any per-hunk state is derived for pieces to keep stable identities across reloads.

Trait Implementations§

Source§

impl Clone for DiffDocument

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DiffDocument

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Decode for DiffDocument

Source§

fn decode(input: &mut impl BufRead) -> Result<Self, DecodeError>

Reads a full diff document from the input stream.

Source§

fn decode_bytes(input: &[u8]) -> Result<Self, DecodeError>

Decodes a diff document from raw bytes.

Non-UTF-8 bytes are replaced with U+FFFD and ANSI escape sequences are stripped before parsing, so output from colored Git pipes round-trips without caller-side preprocessing.

Source§

fn try_decode(input: &mut impl BufRead) -> Result<Option<Self>, DecodeError>

Reads and decodes a value, returning Ok(None) at clean end-of-input. Anything else, including a partial value followed by EOF surfaces as Err.
Source§

fn decode_str(input: &str) -> Result<Self, DecodeError>

Decodes a value from a UTF-8 string.
Source§

impl Default for DiffDocument

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Encode for DiffDocument

Source§

fn encode(&self, out: &mut impl Write) -> Result<()>

Writes the unified-diff representation to out.
Source§

fn to_unified_string(&self) -> Result<String>

Returns the unified-diff representation as a String.
Source§

impl Eq for DiffDocument

Source§

impl PartialEq for DiffDocument

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DiffDocument

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.