Struct MathBox 

pub struct MathBox {
    pub width: Dim,
    pub height: Dim,
    pub depth: Dim,
    pub italic: Dim,
    pub shift: Dim,
    pub content: BoxContent,
}

TeX-style box: width, height above baseline, depth below, italic correction.

Examples

use latex_rust::{Dim, MathBox};

let packed = MathBox::hpack(vec![
    MathBox::rule(Dim::one(), Dim::zero(), Dim::zero()),
    MathBox::rule(Dim::ratio(1, 2), Dim::zero(), Dim::zero()),
]);
assert_eq!(packed.width, Dim::ratio(3, 2));

Fields

width: Dim

Width.

height: Dim

Height above the baseline.

depth: Dim

Depth below the baseline.

italic: Dim

Italic correction.

shift: Dim

Baseline raise relative to the parent list (positive is up).

content: BoxContent

Payload.

Implementations

impl MathBox

pub fn empty() -> Self

Zero-size empty box.

pub fn rule(width: Dim, height: Dim, depth: Dim) -> Self

Rule with explicit dimensions (fraction bar, strut).

pub fn kern(width: Dim) -> Self

Horizontal kern of width (zero height and depth).

pub fn from_glyph(font: &MathFont, ch: char) -> Result<Self, Error>

Box from a font glyph. Errors if the face has no glyph for ch.

pub fn hpack(children: Vec<Self>) -> Self

Pack boxes in a row. Width sums; height and depth are maxima.

pub fn vpack(children: Vec<Self>) -> Self

Pack boxes in a column, first child on the baseline.

Subsequent children sit below the previous (height + depth stacked).

pub fn with_shift(self, shift: Dim) -> Self

Raise this box’s baseline by shift (positive is up).

pub fn dim_gold(&self) -> String

Gold-stable width/height/depth decimal string.

Trait Implementations

impl Clone for MathBox

fn clone(&self) -> MathBox

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MathBox

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

Formats the value using the given formatter.

impl Eq for MathBox

impl PartialEq for MathBox

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MathBox