Struct NodeRef 

pub struct NodeRef<'a> { /* private fields */ }

Read-only borrowed handle to a node within a Document.

Implementations

impl<'a> NodeRef<'a>

pub fn id(&self) -> NodeId

Opaque public handle for this node.

pub fn kind(&self) -> NodeKind

Lightweight node discriminant.

pub fn is_command(&self, name: &str) -> bool

true when this is a command named name.

pub fn is_char(&self, c: char) -> bool

true when this is a char node equal to c.

pub fn is_error(&self) -> bool

true when this is an Error placeholder.

pub fn parent(&self) -> Option<NodeRef<'a>>

Parent handle, or None for the root / a detached node.

pub fn children(&self) -> impl Iterator<Item = NodeRef<'a>> + 'a

Direct children (root/group only; other kinds yield an empty iterator).

pub fn next_sibling(&self) -> Option<NodeRef<'a>>

Next sibling when attached as a group child.

pub fn prev_sibling(&self) -> Option<NodeRef<'a>>

Previous sibling when attached as a group child.

pub fn ancestors(&self) -> impl Iterator<Item = NodeRef<'a>> + 'a

Ancestors from immediate parent up to the root.

pub fn descendants(&self) -> impl Iterator<Item = NodeRef<'a>> + 'a

All descendants in depth-first order, excluding self.

pub fn command_name(&self) -> Option<&'a str>

Command/infix/declarative name without leading backslash.

pub fn env_name(&self) -> Option<&'a str>

Environment name without begin/end.

pub fn text(&self) -> Option<&'a str>

Text payload for a Text node.

pub fn char(&self) -> Option<char>

Character for a Char node.

pub fn prime_count(&self) -> Option<usize>

Prime mark count for a Prime node.

pub fn error_parts(&self) -> Option<(&'a str, &'a str)>

Error message + snippet for an Error node.

pub fn content_mode(&self) -> Option<ContentMode>

Content mode for root/group nodes.

pub fn group_kind(&self) -> Option<GroupKindRef<'a>>

Group kind for group nodes.

pub fn arg_count(&self) -> usize

Number of argument slots on a command-like node.

pub fn arg(&self, index: usize) -> Option<ArgRef<'a>>

Argument at index.

pub fn arg_slots(&self) -> impl Iterator<Item = Option<ArgRef<'a>>> + 'a

All argument slots.

pub fn script_base(&self) -> Option<NodeRef<'a>>

Scripted base.

pub fn subscript(&self) -> Option<NodeRef<'a>>

Scripted subscript.

pub fn superscript(&self) -> Option<NodeRef<'a>>

Scripted superscript.

pub fn infix_left(&self) -> Option<NodeRef<'a>>

Infix left operand.

pub fn infix_right(&self) -> Option<NodeRef<'a>>

Infix right operand.

pub fn env_body(&self) -> Option<NodeRef<'a>>

Environment body group.

pub fn span(&self) -> Option<Span>

Parse-time byte span, if known.

Trait Implementations

impl<'a> Clone for NodeRef<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for NodeRef<'a>

impl Debug for NodeRef<'_>

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

Formats the value using the given formatter.