Struct SummaryDocument 

#[non_exhaustive]
pub struct SummaryDocument {
    pub document_json: Vec<u8>,
    pub version: u64,
    pub patch_kind: PatchKind,
    pub last_updated_ms: u64,
    pub first_applied_ms: u64,
}

Materialised rolling summary document returned by a summary-read call (RFC-015 §6.3).

document is the caller-owned JSON value; scalar leaves that the caller wrote through the SUMMARY_NULL_SENTINEL contract appear here as JSON null (not as the sentinel string — the round-trip invariant erases the sentinel on read).

#[non_exhaustive] keeps future additive fields (e.g. a compacted delta cursor, a schema-version tag) additive. Construct via Self::new.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

document_json: Vec<u8>

The rolling summary as JSON bytes (UTF-8, encoded by the server-side applier after merge). Stored as Vec<u8> instead of serde_json::Value to keep ff_core::backend free of a public serde_json type dependency.

version: u64

Monotonic version bumped on every delta applied. 0 is never observed — the first applied delta returns 1.

patch_kind: PatchKind

Which PatchKind was used to build the document.

last_updated_ms: u64

Unix millis of the most recent delta application.

first_applied_ms: u64

Unix millis of the first delta applied to this attempt.

Implementations

impl SummaryDocument

pub fn new( document_json: Vec<u8>, version: u64, patch_kind: PatchKind, last_updated_ms: u64, first_applied_ms: u64, ) -> SummaryDocument

Build a summary snapshot. Used by backends parsing the Hash fields; external consumers receive these from read_summary.

Trait Implementations

impl Clone for SummaryDocument

fn clone(&self) -> SummaryDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryDocument

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

Formats the value using the given formatter.

impl PartialEq for SummaryDocument

fn eq(&self, other: &SummaryDocument) -> 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 Eq for SummaryDocument

impl StructuralPartialEq for SummaryDocument