Struct DiffDocument 

pub struct DiffDocument {
    pub repo_root: String,
    pub files: Vec<FileDiff>,
}

A complete renderer-neutral review snapshot: every changed file with its patch and, when captured, both complete source versions.

Fields

repo_root: String

files: Vec<FileDiff>

Implementations

impl DiffDocument

pub fn empty() -> DiffDocument

pub fn from_texts<'a, T, U>(files: U) -> Result<DiffDocument, DiffError>

where T: TryInto<RepoPath>, <T as TryInto<RepoPath>>::Error: Into<RepoPathError>, U: IntoIterator<Item = (T, &'a str, &'a str)>,

Builds a complete document from full old/new text pairs, deriving

pub fn file_index(&self, path: &RepoPath) -> Option<usize>

impl DiffDocument

pub fn from_git_outputs( repo_root: impl Into<String>, diff: &[u8], porcelain: &[u8], scope: DiffScope, ) -> Result<DiffDocument, DiffError>

Builds a document from Git patch and porcelain status output.

Errors

Returns an error when either Git output cannot be parsed or normalized.

pub fn from_git_outputs_with_untracked( repo_root: impl Into<String>, diff: &[u8], porcelain: &[u8], scope: DiffScope, untracked: &[UntrackedFile], ) -> Result<DiffDocument, DiffError>

Builds a document from Git outputs plus separately loaded untracked files.

Errors

Returns an error when Git output or untracked file data cannot be parsed or normalized.

Trait Implementations

impl Clone for DiffDocument

fn clone(&self) -> DiffDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiffDocument

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

Formats the value using the given formatter.

impl Default for DiffDocument

fn default() -> DiffDocument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DiffDocument

fn deserialize<__D>( __deserializer: __D, ) -> Result<DiffDocument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DiffDocument

impl PartialEq for DiffDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DiffDocument

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DiffDocument