Struct Node 

pub struct Node {
    pub kind: &'static str,
    pub span: Span,
    pub text: Option<String>,
    pub attrs: Attrs,
    pub children: Vec<Node>,
}

One doctree node. Element nodes have text == None; text leaves have kind == kinds::TEXT, Some(text), and no children or attributes.

Fields

kind: &'static str

span: Span

text: Option<String>

attrs: Attrs

children: Vec<Node>

Implementations

impl Node

pub fn elem(kind: &'static str, span: Span) -> Node

pub fn text_node(s: impl Into<String>, span: Span) -> Node

pub fn shallow_copy(&self) -> Node

docutils Element.copy(): same kind, span and attributes, but no children (docutils copies rawsource and attributes only; deepcopy is the one that takes the subtree).

pub fn set(&mut self, key: &'static str, value: AttrValue)

Set a scalar attribute, keeping attrs.extra sorted by key and overwriting any existing value for the same key.

pub fn get(&self, key: &'static str) -> Option<&AttrValue>

pub fn astext(&self) -> String

Concatenated text of all text descendants.

Wave-1 simplification of docutils Node.astext(): children join with "" (docutils joins with a per-element child_text_separator, which only matters for elements wave 1 never calls astext on — revisit in wave 2 when inline nodes need " " and table cells need "\n\n").

pub fn pformat(&self) -> String

Byte-parity pseudo-XML rendering (docutils document.pformat()).

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Node

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Node

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Node

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 Node