Enum VBoxInfo 

pub enum VBoxInfo<ET: EngineTypes> {
    VBox {
        scaled: ToOrSpread<ET::Dim>,
        assigned_width: Option<ET::Dim>,
        assigned_height: Option<ET::Dim>,
        assigned_depth: Option<ET::Dim>,
        moved_left: Option<ET::Dim>,
        raised: Option<ET::Dim>,
        computed_width: OnceLock<ET::Dim>,
        computed_height: OnceLock<ET::Dim>,
        computed_depth: OnceLock<ET::Dim>,
    },
    VTop {
        scaled: ToOrSpread<ET::Dim>,
        assigned_width: Option<ET::Dim>,
        assigned_height: Option<ET::Dim>,
        assigned_depth: Option<ET::Dim>,
        moved_left: Option<ET::Dim>,
        raised: Option<ET::Dim>,
        computed_width: OnceLock<ET::Dim>,
        computed_height: OnceLock<ET::Dim>,
        computed_depth: OnceLock<ET::Dim>,
    },
    VAlignColumn,
    VAlignCell {
        to: Option<ET::Dim>,
        spans: u8,
    },
}

“Metadata” of a vertical box

Variants

VBox

A “normal” \vbox

Fields

scaled: ToOrSpread<ET::Dim>

scaling factor

assigned_width: Option<ET::Dim>

width, if assigned via e.g. \wd0=50pt

assigned_height: Option<ET::Dim>

height, if assigned via e.g. \ht0=50pt

assigned_depth: Option<ET::Dim>

depth, if assigned via e.g. \dp0=50pt

moved_left: Option<ET::Dim>

horizontal movement, if moved via e.g. \moveleft 50pt (or \moveright)

raised: Option<ET::Dim>

vertical movement, if raised via e.g. \raise 50pt (or \lower)

computed_width: OnceLock<ET::Dim>

computed width by taking the maximum width of all children

computed_height: OnceLock<ET::Dim>

computed height by summing the heights and depths of all children (except for the last)

computed_depth: OnceLock<ET::Dim>

computed depth by taking the depth of the last child box

VTop

A \vtop box

Fields

scaled: ToOrSpread<ET::Dim>

scaling factor

assigned_width: Option<ET::Dim>

width, if assigned via e.g. \wd0=50pt

assigned_height: Option<ET::Dim>

height, if assigned via e.g. \ht0=50pt

assigned_depth: Option<ET::Dim>

depth, if assigned via e.g. \dp0=50pt

moved_left: Option<ET::Dim>

horizontal movement, if moved via e.g. \moveleft 50pt (or \moveright)

raised: Option<ET::Dim>

vertical movement, if raised via e.g. \raise 50pt (or \lower)

computed_width: OnceLock<ET::Dim>

computed width by taking the maximum width of all children

computed_height: OnceLock<ET::Dim>

computed height by taking the height of the first child box

computed_depth: OnceLock<ET::Dim>

computed depth by taking the height + depth of all children minus the computed height

VAlignColumn

A column in a \valign; should only contain VBoxInfo::VAlignCells

VAlignCell

A cell in a \valign

Fields

to: Option<ET::Dim>

The height of the cell, as computed by comparing all cells in the same row (not yet implemented)

spans: u8

The number of additional rows this cell spans (i.e. by default 0)

Implementations

impl<ET: EngineTypes> VBoxInfo<ET>

pub fn new_box(scaled: ToOrSpread<ET::Dim>) -> Self

Create a new \vbox box info with the given scaling factor

pub fn to_vbox(&mut self)

Convert this box to a \vbox (or \vtop if it already is a \vtop)

pub fn new_top(scaled: ToOrSpread<ET::Dim>) -> Self

Create a new \vtop box info with the given scaling factor

pub fn open_list(self, start: SourceRef<ET>) -> NodeList<ET>

Turns this box info into the corresponding NodeList

pub fn clone_for_split(&mut self) -> Self

Clone this box info for use in a split box (i.e. \vsplit)

pub fn raise(&mut self, d: ET::Dim)

Raise this box by the given amount (i.e. \raise or \lower)

pub fn move_left(&mut self, d: ET::Dim)

Move this box left by the given amount (i.e. \moveleft or \moveright)

impl<ET: EngineTypes> VBoxInfo<ET>

pub fn assigned_height(&self) -> Option<ET::Dim>

pub fn assigned_width(&self) -> Option<ET::Dim>

pub fn assigned_depth(&self) -> Option<ET::Dim>

pub fn computed_height(&self) -> Option<ET::Dim>

pub fn computed_width(&self) -> Option<ET::Dim>

pub fn computed_depth(&self) -> Option<ET::Dim>

pub fn raised(&self) -> Option<ET::Dim>

pub fn moved_left(&self) -> Option<ET::Dim>

pub fn to_or_scaled(&self) -> Option<ToOrSpread<ET::Dim>>

Trait Implementations

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

where ET::Dim: Clone,

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

where ET::Dim: Debug,

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

Formats the value using the given formatter.

impl<ET: EngineTypes> Display for VBoxInfo<ET>

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

Formats the value using the given formatter.

impl<ET: PartialEq + EngineTypes> PartialEq for VBoxInfo<ET>

where ET::Dim: PartialEq,

fn eq(&self, other: &VBoxInfo<ET>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<ET: Eq + EngineTypes> Eq for VBoxInfo<ET>

where ET::Dim: Eq,

impl<ET: EngineTypes> StructuralPartialEq for VBoxInfo<ET>