Enum VNode 

pub enum VNode<ET: EngineTypes> {
    Penalty(i32),
    Mark(usize, TokenList<ET::Token>),
    Whatsit(WhatsitNode<ET>),
    VSkip(Skip<ET::Dim>),
    VFil,
    VFill,
    VFilneg,
    Vss,
    VKern(ET::Dim),
    Leaders(Leaders<ET>),
    Box(TeXBox<ET>),
    HRule {
        width: Option<ET::Dim>,
        height: Option<ET::Dim>,
        depth: Option<ET::Dim>,
        start: SourceRef<ET>,
        end: SourceRef<ET>,
    },
    Insert(usize, Box<[VNode<ET>]>),
    Custom(ET::CustomNode),
}

A vertical list node.

Variants

Penalty(i32)

A penalty node, as produced by \penalty.

Mark(usize, TokenList<ET::Token>)

A mark node, as produced by \mark.

Whatsit(WhatsitNode<ET>)

A whatsit node, as produced by \special, \write, etc.

VSkip(Skip<ET::Dim>)

A glue node, as produced by \vskip.

VFil

A glue node, as produced by \vfil.

VFill

A glue node, as produced by \vfill.

VFilneg

A glue node, as produced by \vfilneg.

Vss

A glue node, as produced by \vss.

VKern(ET::Dim)

A kern node, as produced by \kern.

Leaders(Leaders<ET>)

Leaders, as produced by \leaders or \cleaders or \xleaders.

Box(TeXBox<ET>)

A box node, as produced by \hbox, \vbox, \vtop, etc.

HRule

A rule node, as produced by \hrule.

Fields

width: Option<ET::Dim>

The provided width of the rule.

height: Option<ET::Dim>

The provided height of the rule.

depth: Option<ET::Dim>

The provided depth of the rule.

start: SourceRef<ET>

The source reference for the start of the rule.

end: SourceRef<ET>

The source reference for the end of the rule.

Insert(usize, Box<[VNode<ET>]>)

An insertion node, as produced by \insert.

Custom(ET::CustomNode)

A custom node.

Implementations

impl<ET: EngineTypes> VNode<ET>

pub fn discardable(&self) -> bool

Whether this node is discardable.

Trait Implementations

impl<ET: Clone + EngineTypes> Clone for VNode<ET>

where ET::Token: Clone, ET::Dim: Clone, ET::CustomNode: Clone,

fn clone(&self) -> VNode<ET>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ET: Debug + EngineTypes> Debug for VNode<ET>

where ET::Token: Debug, ET::Dim: Debug, ET::CustomNode: Debug,

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

Formats the value using the given formatter.

impl<ET: EngineTypes> NodeTrait<ET> for VNode<ET>

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

Produces a human-readable string; since nodes are deeply nested, takes an additional indent value to indent the string

fn height(&self) -> ET::Dim

Returns the height of the node.

fn width(&self) -> ET::Dim

Returns the width of the node.

fn depth(&self) -> ET::Dim

Returns the depth of the node.

fn nodetype(&self) -> NodeType

Returns the type of the node, as returned by \lastnodetype.

fn opaque(&self) -> bool

Whether this node is “opaque”; meaning: When considering a list of nodes (e.g. in \unskip or \lastbox, this node should not be considered. Useful for annotation/marker nodes some engine wants to insert, without impacting algorithms that inspect e.g. the last node of the current list.

fn sourceref(&self) -> Option<(&SourceRef<ET>, &SourceRef<ET>)>

fn display(&self) -> DisplayNode<'_, ET, Self>

Returns a helper struct that implements Display and uses Self::display_fmt to yield a human-readable string.