Struct FileDiff 

pub struct FileDiff {
    pub old_path: Option<RepoPath>,
    pub path: RepoPath,
    pub status: FileStatus,
    pub staged: StageState,
    pub hunks: Vec<Hunk>,
    pub binary: bool,
    pub mode: Option<ModeChange>,
    pub no_newline_at_end: bool,
    pub omitted_bytes: Option<u64>,
    pub old_source: Result<Arc<SourceDocument>, SourceUnavailable>,
    pub new_source: Result<Arc<SourceDocument>, SourceUnavailable>,
}

One changed file.

old_source and new_source hold the complete versions of each side. When both are available the hunks are derived from them, so equal sides imply equal hunks; otherwise the hunks are the patch as supplied.

Fields

old_path: Option<RepoPath>

path: RepoPath

status: FileStatus

staged: StageState

hunks: Vec<Hunk>

binary: bool

mode: Option<ModeChange>

no_newline_at_end: bool

omitted_bytes: Option<u64>

old_source: Result<Arc<SourceDocument>, SourceUnavailable>

new_source: Result<Arc<SourceDocument>, SourceUnavailable>

Implementations

impl FileDiff

pub fn path_for_side(&self, side: DiffSide) -> &RepoPath

Returns the repository path used by one side of this file version.

pub fn from_texts<T>( path: T, old: &str, new: &str, ) -> Result<FileDiff, DiffError>

where T: TryInto<RepoPath>, <T as TryInto<RepoPath>>::Error: Into<RepoPathError>,

Builds a one-file diff from complete old and new text snapshots.

Errors

Returns an error when path is not a valid repository-relative path.

pub fn with_sources( self, old: Result<Arc<SourceDocument>, SourceUnavailable>, new: Result<Arc<SourceDocument>, SourceUnavailable>, ) -> FileDiff

Attaches captured source versions, re-deriving the hunks from them when both sides are known. Git metadata such as status, staging, mode, and paths is kept as supplied; a binary file keeps its patch untouched.

pub const fn uncaptured_source( status: FileStatus, side: DiffSide, ) -> Result<Arc<SourceDocument>, SourceUnavailable>

The source result recorded for a side of a file whose complete versions were not captured.

Errors

Always an unavailable reason: SourceUnavailable::Absent where the status says the side cannot exist, SourceUnavailable::NotCaptured otherwise.

pub const fn source( &self, side: DiffSide, ) -> &Result<Arc<SourceDocument>, SourceUnavailable>

Returns the complete source result for one side.

pub fn source_document(&self, side: DiffSide) -> Option<&Arc<SourceDocument>>

Returns the complete source document for one side when it is available.

pub fn source_unavailable(&self, side: DiffSide) -> Option<&SourceUnavailable>

Returns why one side has no complete source document.

pub fn content_id(&self) -> Fingerprint

Content identity used to decide whether presentation state derived from this file, such as revealed gaps, still applies after a replacement.

The identity covers both sides. When either side is unavailable the hunks are the content and are covered too; when both are available the hunks are derived from them and add nothing.

pub fn additions(&self) -> usize

Number of added lines.

pub fn deletions(&self) -> usize

Number of removed lines.

pub fn language(&self) -> &str

Lowercase file extension, without a dot.

pub fn line(&self, hunk: usize, line: usize) -> Option<&PatchLine>

Trait Implementations

impl Clone for FileDiff

fn clone(&self) -> FileDiff

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileDiff

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileDiff

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileDiff

impl PartialEq for FileDiff

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FileDiff

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 FileDiff