Module boxworks::ds

source ·
Expand description

Core data structures for the typesetting engine.

This module contains the fundamental data structures for the Boxworks typesetting engine. As in TeX, the Boxworks is based around various lists (horizontal, vertical, etc.) that contains elements (which themselves may be nested lists). The Rust representations of these lists and their elements are defined here.

This module implements the entirety of TeX.2021 part 10, “data structures for boxes and their friends”.

Structs§

  • Adjust
    Specifies material that will be moved out into the surrounding vertical list.
  • Char
    A character in a specific font.
  • Discretionary
    A discretionary break.
  • Glue
    A piece of glue.
  • GlueRatio
    Ratio by which glue should shrink or stretch.
  • HList
    A box made from a horizontal list.
  • Insertion
    Vertical material to be inserted.
  • Kern
    A kern.
  • Ligature
    A ligature.
  • Mark
    Contents of a user’s \mark text.
  • Penalty
    A penalty.
  • Rule
    A rule stands for a solid black rectangle.
  • VList
    A box made from a vertical list.

Enums§

  • GlueKind
    The kind of a glue node.
  • GlueSign
    Description of whether the glue should stretch, shrink, or remain rigid.
  • Horizontal
    Element of a horizontal list.
  • KernKind
    The kind of a kern node.
  • Math
    A marker placed before or after math mode.
  • Vertical
    Element of a vertical list.

Traits§