Skip to main content

NodeFlags

Struct NodeFlags 

Source
pub struct NodeFlags {
    pub generated: bool,
    pub sentence_end: bool,
    pub no_print: bool,
    pub no_fill: bool,
    pub deep_link_target: bool,
    pub permalink: bool,
    pub line_start: bool,
    pub delimiter_open: bool,
    pub delimiter_close: bool,
    pub line_continuation: bool,
    pub synopsis_pretty: bool,
}
Expand description

Source and renderer flags needed by a lowering or rendering pass.

Fields§

§generated: bool

The node was synthesized by libmandoc rather than written explicitly.

§sentence_end: bool

The node ends a sentence according to libmandoc punctuation rules.

§no_print: bool

The node must not contribute visible output.

§no_fill: bool

The node belongs to a no-fill region that preserves source lines.

§deep_link_target: bool

libmandoc selected this node as a same-document destination.

§permalink: bool

libmandoc renders a self-link for this destination.

§line_start: bool

This node begins a roff input line (NODE_LINE).

Some man macros keep same-line layout arguments and next-line visible content in one syntax head, so source-line role is semantic data.

§delimiter_open: bool

This text node is opening punctuation and suppresses spacing after it.

§delimiter_close: bool

This text node is closing punctuation and suppresses spacing before it.

§line_continuation: bool

This text node ends with the roff \c escape and joins the next input line without an implicit space or line break.

§synopsis_pretty: bool

libmandoc selected synopsis-style presentation for this node.

Some semantic punctuation is generated only in this context, notably the terminating semicolon of mdoc Fn and Fo declarations.

Trait Implementations§

Source§

impl Clone for NodeFlags

Source§

fn clone(&self) -> NodeFlags

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 Copy for NodeFlags

Source§

impl Debug for NodeFlags

Source§

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

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

impl Default for NodeFlags

Source§

fn default() -> NodeFlags

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for NodeFlags

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 NodeFlags

Source§

impl PartialEq for NodeFlags

Source§

fn eq(&self, other: &NodeFlags) -> 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 NodeFlags

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 NodeFlags

Auto Trait Implementations§

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.