Struct Document 

pub struct Document {
    pub root: Vec<NodeDoc>,
    /* private fields */
}

A whole document on disk.

The live editor uses slotmap ids and parent links. This type deliberately contains neither, making the persisted representation deterministic and independent of allocation history. For example, an x atom is represented in JSON as:

{"version":1,"root":[{"type":"atom","data":{"latex":"x","class":"ord"}}]}

Fields

root: Vec<NodeDoc>

The nodes in the document’s root sequence.

Implementations

impl Document

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

Build a document containing root using the current format version.

pub fn version(&self) -> u32

Return the serialized format version.

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

Return the nodes in the root sequence.

pub fn len(&self) -> usize

Return the number of nodes in the root sequence.

pub fn is_empty(&self) -> bool

Return whether the root sequence contains no nodes.

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

Consume the document and return its root sequence.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

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: &Document) -> 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