Struct Leaders

pub struct Leaders<ET: EngineTypes> {
    pub tp: LeaderType,
    pub body: LeaderBody<ET>,
    pub skip: LeaderSkip<ET>,
}

A \leaders node, as produced by \leaders, \cleaders or \xleaders.

Fields

tp: LeaderType

\leaders, \cleaders or \xleaders.

body: LeaderBody<ET>

The node to be repeated for the given skip length; a box or a rule.

skip: LeaderSkip<ET>

The skip length along which the body should be repeated.

Trait Implementations

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

fn clone(&self) -> Leaders<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 Leaders<ET>

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

Formats the value using the given formatter.

impl<ET: EngineTypes> NodeTrait<ET> for Leaders<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 display(&self) -> DisplayNode<'_, ET, Self>

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

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>)>