Struct DocApiDiff 

pub struct DocApiDiff<'a, I: Invoker> { /* private fields */ }

Implementations

impl<'a, I: Invoker> DocApiDiff<'a, I>

pub fn new(invoker: &'a I) -> Self

pub fn apply<'call>( &'call self, params: &'call DocDiffApplyBoundParams, ) -> impl Future<Output = Result<DocDiffApplyResult>> + Send + 'call

Apply a previously computed diff payload to the current document. The document fingerprint must match the diff base fingerprint. Omitted changeMode applies story content directly; explicit tracked mode governs all four story families (body, header/footer parts, footnotes, endnotes). Comments, styles, and numbering are always applied directly. Supported mixed full-diff payloads apply atomically across body, comments, styles, numbering, and header/footers. Unsupported/deferred families such as package-graph/media/hyperlink closure, settings/theme, and textboxes fail closed before mutation.

pub async fn apply_with_options( &self, params: &DocDiffApplyBoundParams, options: InvokeOptions, ) -> Result<DocDiffApplyResult>

Apply a previously computed diff payload to the current document. The document fingerprint must match the diff base fingerprint. Omitted changeMode applies story content directly; explicit tracked mode governs all four story families (body, header/footer parts, footnotes, endnotes). Comments, styles, and numbering are always applied directly. Supported mixed full-diff payloads apply atomically across body, comments, styles, numbering, and header/footers. Unsupported/deferred families such as package-graph/media/hyperlink closure, settings/theme, and textboxes fail closed before mutation.

pub fn capture<'call>( &'call self, params: &'call DocDiffCaptureBoundParams, ) -> impl Future<Output = Result<DocDiffCaptureResult>> + Send + 'call

Capture the current document’s diffable state as a versioned snapshot. v2 capture requires source-complete state and reports coverage for body, comments, styles, numbering, and header/footers, with extended family coverage carried in the opaque payload. Legacy body-only v2 artifacts remain accepted for compare/apply compatibility.

pub async fn capture_with_options( &self, params: &DocDiffCaptureBoundParams, options: InvokeOptions, ) -> Result<DocDiffCaptureResult>

Capture the current document’s diffable state as a versioned snapshot. v2 capture requires source-complete state and reports coverage for body, comments, styles, numbering, and header/footers, with extended family coverage carried in the opaque payload. Legacy body-only v2 artifacts remain accepted for compare/apply compatibility.

pub fn compare<'call>( &'call self, params: &'call DocDiffCompareBoundParams, ) -> impl Future<Output = Result<DocDiffCompareResult>> + Send + 'call

Compare the current document (base) against a previously captured target snapshot. Returns a versioned diff payload whose summary reports which components changed: body, comments, styles, numbering, header/footers, and parts.

pub async fn compare_with_options( &self, params: &DocDiffCompareBoundParams, options: InvokeOptions, ) -> Result<DocDiffCompareResult>

Compare the current document (base) against a previously captured target snapshot. Returns a versioned diff payload whose summary reports which components changed: body, comments, styles, numbering, header/footers, and parts.