Struct Document 

pub struct Document {
    pub root: AstNode,
    pub source_path: Option<String>,
    pub source_text: Option<String>,
}

Represents a complete NOML document with metadata

Fields

root: AstNode

Root value of the document (typically a table)

source_path: Option<String>

Source file path (if loaded from file)

source_text: Option<String>

Original source text (for error reporting and round-trip)

Implementations

impl Document

pub fn new(root: AstNode) -> Self

Create a new document

pub fn with_source( root: AstNode, path: Option<String>, text: Option<String>, ) -> Self

Create a document with source information

pub fn to_value(&self) -> Result<Value>

Convert the AST to a Value tree (losing source information)

pub fn source_text_for_span(&self, span: &Span) -> Option<&str>

Get the source text for a span

pub fn node_at_offset(&self, offset: usize) -> Option<&AstNode>

Find the AST node at a given byte offset

pub fn all_comments(&self) -> Vec<&Comment>

Get all comments in the document

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 PartialEq for Document

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Document