Struct Doctree 

pub struct Doctree {
    pub root: Node,
    pub sources: Vec<String>,
}

One parsed document. root.kind == kinds::DOCUMENT.

Fields

root: Node

sources: Vec<String>

The source table Span.source indexes: one path per source the parse consumed. Entry 0 is the document’s own path; sub-parses over lifted text (table cells) and, later, included files push further entries. #[serde(default = "default_sources")] is the standard hedge for a field added after data in this shape might already exist — but note it only rescues self-describing formats (e.g. JSON) from a missing field: bincode’s wire format has no field-presence framing, so a bincode blob that predates this field would still fail to decode (UnexpectedEnd) rather than fall back to the default. No such blob existed before the field did, so that gap isn’t live today.

Implementations

impl Doctree

pub fn source_and_line(&self, span: Span) -> (&str, u32)

The (source path, line) a warning about a node should report — docutils’ (node.source, node.line). Line 0 means unknown; a source the table doesn’t know (a foreign or hand-built span) falls back to the document’s own path.

Trait Implementations

impl Clone for Doctree

fn clone(&self) -> Doctree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doctree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Doctree

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Doctree

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Doctree

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 Doctree