Skip to main content

Node

Struct Node 

Source
pub struct Node {
Show 17 fields pub kind: NodeKind, pub macro_name: Option<String>, pub text: Option<String>, pub tag: Option<String>, pub line: u32, pub column: u32, pub flags: NodeFlags, pub list_kind: Option<NormalizedListKind>, pub display_kind: Option<DisplayKind>, pub font: Option<NormalizedFont>, pub author_mode: Option<AuthorMode>, pub compact: bool, pub offset: Option<String>, pub width: Option<String>, pub table_cells: Vec<TableCell>, pub equation: Option<String>, pub children: Vec<Self>,
}
Expand description

An owned syntax node with no pointers into the C parser.

Fields§

§kind: NodeKind

Structural role of this node in the libmandoc tree.

§macro_name: Option<String>

Source macro name, without the leading dot, when applicable.

§text: Option<String>

Visible text carried by a text node.

§tag: Option<String>

Canonical same-document tag assigned during libmandoc validation.

§line: u32

One-based source line reported by libmandoc, or zero when unavailable.

§column: u32

One-based source column reported by libmandoc, or zero when unavailable.

§flags: NodeFlags

Source and renderer flags attached to the node.

§list_kind: Option<NormalizedListKind>

Normalized list behavior for an mdoc list block.

§display_kind: Option<DisplayKind>

Fill behavior for an mdoc display block.

§font: Option<NormalizedFont>

Font selected by an mdoc font block.

§author_mode: Option<AuthorMode>

Author layout mode selected by an mdoc author macro.

§compact: bool

Whether the enclosing list requests compact vertical layout.

§offset: Option<String>

Raw normalized display/list offset, including a roff scale suffix.

§width: Option<String>

Normalized mdoc(7) list width, including its roff scale suffix.

§table_cells: Vec<TableCell>

Cells copied from a tbl(7) row represented by this node.

§equation: Option<String>

Normalized eqn(7) expression carried by this node.

§children: Vec<Self>

Child nodes in source order.

Trait Implementations§

Source§

impl Clone for Node

Source§

fn clone(&self) -> Node

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Node

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Node

Source§

impl PartialEq for Node

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Node

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Node

Auto Trait Implementations§

§

impl Freeze for Node

§

impl RefUnwindSafe for Node

§

impl Send for Node

§

impl Sync for Node

§

impl Unpin for Node

§

impl UnsafeUnpin for Node

§

impl UnwindSafe for Node

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.