Struct ReviewDocument 

pub struct ReviewDocument {
    pub schema_version: u32,
    pub tool: String,
    pub repo: String,
    pub base: RefInfo,
    pub head: RefInfo,
    pub comments: Vec<Comment>,
}

The mutable review state for one (repo, base_sha, head_sha) diff.

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"); distinguishes exported files from look-alike JSON of other origins.

repo: String

Repository directory name the review belongs to.

base: RefInfo

The reviewed diff’s base ref, pinned to its SHA.

head: RefInfo

The reviewed diff’s head ref, pinned to its SHA.

comments: Vec<Comment>

The comments, always in the canonical order (ReviewDocument::sort).

Implementations

impl ReviewDocument

pub fn new(repo: String, base: RefInfo, head: RefInfo) -> Self

pub fn parse(json: &str) -> Result<Self, ModelError>

Parse and validate a document. Rejects documents from a newer schema and any unknown field (strict deserialization); re-validates and re-sorts every comment so untrusted input (an imported file, a hand-edited store) is normalized on the way in.

pub fn to_json_pretty(&self) -> String

Canonical serialized form (pretty, trailing newline) — what exports and the localStorage round-trip use.

pub fn upsert(&mut self, comment: Comment) -> Result<(), ModelError>

Insert a new comment or replace the one with the same id.

pub fn delete(&mut self, id: &str) -> bool

Remove a comment by id. Returns whether anything was removed.

pub fn merge(&mut self, incoming: &ReviewDocument)

Merge another document’s comments into this one (the import path).

Semantics: union by id; on an id collision the comment with the later updated_at wins (RFC 3339 UTC strings compare correctly lexicographically); an exact tie keeps the existing comment. Metadata (repo/refs) of self is kept — importing does not re-target a store.

pub fn sort(&mut self)

Restore the canonical deterministic order.

Trait Implementations

impl Clone for ReviewDocument

fn clone(&self) -> ReviewDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReviewDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReviewDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReviewDocument

impl PartialEq for ReviewDocument

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReviewDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReviewDocument