Struct Document 

pub struct Document { /* private fields */ }

A whole document, the unit of persistence and of the clipboard, see the README for its JSON shape.

Implementations

impl Document

pub fn new(root: Vec<NodeDoc>) -> Self

Build a document holding root in the current format version.

pub fn version(&self) -> u32

The serialized format version.

pub fn root(&self) -> &[NodeDoc]

The nodes in the root sequence.

pub fn len(&self) -> usize

Number of nodes in the root sequence.

pub fn is_empty(&self) -> bool

Whether the root sequence is empty.

pub fn into_root(self) -> Vec<NodeDoc>

Consume the document and return its root sequence.

pub fn validate(&self) -> Result<(), DocumentError>

Check every structural rule that deserialization enforces.

pub fn visit(&self, f: impl FnMut(&NodeDoc))

Call f on every node in document order, parents before their slots.

pub fn repair(&mut self) -> Vec<Repair>

Fix everything Document::validate rejects and report each change, in document order.

pub fn visit_mut(&mut self, f: impl FnMut(&mut NodeDoc))

Call f on every node in document order, Document::validate tells whether the result is still valid.

pub fn host_tokens(&self) -> BTreeSet<u32>

Every host box token in the document.

pub fn map_host_tokens(&mut self, f: impl FnMut(u32) -> u32)

Rewrite every host box token, for example after minting fresh tokens on paste.

pub fn to_tex(&self) -> String

Clean LaTeX with empty placeholders dropped, host boxes stay \hostbox{N}.

pub fn to_tex_with(&self, host_box: impl FnMut(u32) -> Option<String>) -> String

Clean LaTeX where host_box supplies each host box’s content, None keeps \hostbox{N}.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Document

impl PartialEq for Document

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Document

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 Document