Skip to main content

DocumentExtension

Struct DocumentExtension 

Source
#[non_exhaustive]
pub struct DocumentExtension { pub schema_version: u16, pub clean_md_sha256: [u8; 32], pub layout_json_sha256: [u8; 32], pub report_json_sha256: [u8; 32], pub preview_png_sha256: Option<[u8; 32]>, pub page_count: u32, pub audit_session_id: String, pub clean_spans: Vec<EmittedTokenSpan>, pub codec_audit: Vec<CodecAuditRow>, }
Expand description

Signed document-context metadata carried inside a session snapshot envelope.

This extension is the v0.7 bridge for gaze-document: it is safe to serialize inside the owner-only snapshot envelope, while agent-facing files keep using non-sensitive mirrors. The single schema_version is bundle-level; sub-files do not carry independent schema versions.

Fields (Non-exhaustive)§

This struct is marked as 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.
§schema_version: u16

Bundle-level schema version shared by clean, layout, preview, report, and manifest files.

§clean_md_sha256: [u8; 32]

SHA-256 of clean.md NFC-normalized bytes.

§layout_json_sha256: [u8; 32]

SHA-256 of canonical layout.json bytes.

§report_json_sha256: [u8; 32]

SHA-256 of canonical report.json bytes.

§preview_png_sha256: Option<[u8; 32]>

SHA-256 of preview-redacted.png bytes when a preview is present.

§page_count: u32

Page count reported for the source document.

§audit_session_id: String

Audit session id mirrored from the writing session for cross-pane correlation.

§clean_spans: Vec<EmittedTokenSpan>

Signed clean.md byte spans for every emitted token.

§codec_audit: Vec<CodecAuditRow>

Codec audit rows for the decode path that produced this document extension.

Implementations§

Source§

impl DocumentExtension

Source

pub fn builder(schema_version: u16) -> DocumentExtensionBuilder

Starts a document extension builder for one bundle schema version.

Trait Implementations§

Source§

impl Clone for DocumentExtension

Source§

fn clone(&self) -> DocumentExtension

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocumentExtension

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DocumentExtension

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for DocumentExtension

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for DocumentExtension

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DocumentExtension

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,