Struct DiffDocument 

pub struct DiffDocument {
    pub schema_version: u32,
    pub tool: String,
    pub repo: String,
    pub base: RefInfo,
    pub head: RefInfo,
    pub merge_base: String,
    pub generated_at: String,
    pub commits: Vec<Commit>,
    pub files: Vec<FileDiff>,
    pub snapshots: Option<RangeSnapshots>,
    pub description: Option<NotesFile>,
}

The immutable build artifact: one rendered diff between two pinned refs.

Fields

schema_version: u32

Schema generation this document was written with; readers reject documents newer than they understand (SCHEMA_VERSION).

tool: String

Producing tool identifier ("packdiff"); lets a reader distinguish this document from look-alike JSON of other origins.

repo: String

Repository directory name — not a path, so documents stay shareable across machines.

base: RefInfo

The base ref, pinned to the SHA it resolved to at build time.

head: RefInfo

The head ref, pinned to the SHA it resolved to at build time.

merge_base: String

The commit the diff actually starts from: merge-base(base, head) in the default three-dot mode, or base itself in two-dot mode.

generated_at: String

Build timestamp, RFC 3339 UTC — supplied by the caller (the model has no clock); the only non-deterministic field in a build.

commits: Vec<Commit>

Commits in the diffed range, oldest first.

files: Vec<FileDiff>

Per-file changes, in the order git emitted them.

snapshots: Option<RangeSnapshots>

File snapshots at every commit boundary, enabling in-page filtering of the diff to any contiguous commit sub-range. None (and omitted from JSON) when not collected — on older builds, or ranges of fewer than two commits, where there is nothing to filter.

description: Option<NotesFile>

The PR description lifted out of the diff (the notes-commit convention: commits authored by the system notes author carry notes such as PR-DESCRIPTION.md, not code under review). Rendered as its own commentable panel; its commits and file are excluded from commits / files. None (and omitted from JSON) when the range has no notes commits.

Implementations

impl DiffDocument

pub fn new( repo: String, base: RefInfo, head: RefInfo, merge_base: String, generated_at: String, commits: Vec<Commit>, files: Vec<FileDiff>, snapshots: Option<RangeSnapshots>, description: Option<NotesFile>, ) -> Self

pub fn additions(&self) -> u32

pub fn deletions(&self) -> u32

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DiffDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.