Struct Cursor 

pub struct Cursor<'a> {
    pub path: String,
    /* private fields */
}

A read-only cursor into a Doc’s tree, tracking its own path.

Path is owned per-cursor (rather than borrowed) because it’s built incrementally ($.a.b[1]) as cursors descend; it’s only needed for error messages and equality with Python’s Doc.path, not perf-critical traversal.

Fields

path: String

The path of this cursor within the document.

Implementations

impl<'a> Cursor<'a>

pub fn id(&self) -> NodeId

The internal NodeId of the referenced node.

pub fn is_leaf(&self) -> bool

Returns true iff this node is a leaf holding a scalar.

pub fn value(&self) -> Result<&'a Scalar, DocumentError>

Returns the scalar value if this is a leaf node, or Err if it is an internal edge node.

pub fn edges(&self) -> Result<Vec<(String, Cursor<'a>)>, DocumentError>

Returns the outgoing labeled edges if this is an internal node, or Err if it is a leaf.

pub fn labels(&self) -> Vec<String>

Returns a deduplicated list of child edge labels.

pub fn get(&self, label: &str) -> Vec<Cursor<'a>>

Returns all child cursors along edges with the given label.

pub fn get_one(&self, label: &str) -> Result<Cursor<'a>, DocumentError>

Returns the single child cursor for label, or Err if there are 0 or >1 matching edges.

pub fn count(&self, label: &str) -> usize

Returns the number of edges with the given label.

pub fn child(&self, label: &str) -> Result<Cursor<'a>, DocumentError>

A cursor to the single child under label.

pub fn to_raw(&self) -> RawNode

A lossless RawNode copy of the subtree rooted at this cursor, preserving edge order and interleaving exactly. Used by crate::materialize to carry an untouched subtree forward (e.g. an unexpected field it still has to emit for a caller inspecting the materialized-but-erroring result) without a second, hand-rolled tree-copy routine.

Trait Implementations

impl<'a> Clone for Cursor<'a>

fn clone(&self) -> Cursor<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Cursor<'a>

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

Formats the value using the given formatter.