Struct Doc 

pub struct Doc { /* private fields */ }

A guarded handle on a Document tree: an arena of nodes plus the root.

Implementations

impl Doc

pub fn of(value: &Value) -> Result<Doc, DocumentError>

Build a Doc from a plain Value.

pub fn root(&self) -> Cursor<'_>

A cursor to the document root, at path "$".

pub fn add( &mut self, at: NodeId, path: &str, label: &str, value: &Value, ) -> Result<NodeId, DocumentError>

Append an edge (label, value) under the node at at/path. A repeated label is how an array grows. Returns the new edge’s NodeId.

pub fn set( &mut self, at: NodeId, path: &str, label: &str, value: &Value, ) -> Result<NodeId, DocumentError>

Replace all edges under label with a single new edge, positioned at the first old occurrence (set = remove + add).

pub fn remove( &mut self, at: NodeId, path: &str, label: &str, ) -> Result<(), DocumentError>

Remove every edge under label.

pub fn to_grouped(&self) -> Value

A JSON-shaped projection of the whole document: same-label edges grouped into an array; a label seen once stays a single value.

pub fn to_data(&self) -> Value

A lossless copy of the whole document back into Value form.

pub fn eq_doc(&self, other: &Doc) -> bool

Structural equality between two documents (same shape, same edge order, same labels, same leaf values).

impl Doc

pub fn from_raw(root: RawNode) -> Result<Doc, DocumentError>

Build a Doc from a RawNode, preserving edge order and interleaving exactly. Depth-guarded via the same check_write_depth every other construction path uses.

pub fn to_raw(&self) -> RawNode

The inverse of Doc::from_raw: a lossless walk back into RawNode form, preserving edge order and interleaving exactly.

impl Doc

Name-keyed dispatch through crate::registry (issue #31), mirroring Python’s Doc.from_format/to_format/check_format in ~/dev/omnist/omnist/document.py. Kept as its own impl Doc block (rather than folded into the constructors/export blocks above) since it is the one place Doc depends on the registry module rather than a single format module directly.

pub fn from_format(name: &str, text: &str) -> Result<Doc, OmnistError>

Read text as the registered format name (an crate::error::OmnistError::Format if name isn’t registered). Mirrors Python’s Doc.from_format(name, text).

pub fn to_format(&self, name: &str) -> Result<String, OmnistError>

Write self as the registered format name. Mirrors Python’s Doc.to_format(name).

pub fn check_format(&self, name: &str) -> Result<WriteReport, OmnistError>

Simulate writing self as the registered format name, without producing output. Mirrors Python’s Doc.check_format(name): an crate::error::OmnistError::Document if name’s registered crate::registry::Format has no check callable (a plugin registered via crate::registry::Format::new alone) – not a panic.

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.