Skip to main content

Crate mathtex_engine

Crate mathtex_engine 

Source
Expand description

Typesets LaTeX math with a XeTeX engine: bake a Format once, then Typesetter::typeset fragments.

Re-exports§

pub use mathtex_font as font;

Structs§

Diagnostic
A warning raised while typesetting.
FileSystemResourceProvider
Resource provider over a directory, a request’s canonical name is a path relative to the root.
Format
A validated packaged XeTeX format and its native fonts, the same bytes load on every little endian target.
FormatBuilder
Bakes a packaged format: INITEX runs an optional kernel file, then the preamble, then dumps.
HostBox
A host laid out box, its runs and rules drawn relative to its baseline origin with y down.
HostBoxGlyph
A glyph at its baseline origin, relative to the box’s baseline origin with y down.
HostBoxRequest
One placement of \hostbox{token}.
HostBoxRule
A filled rectangle whose bottom left corner is origin, relative to the box’s baseline origin with y down.
HostBoxRun
Glyphs of one face inside a host box, the fragment carries the key so the host can draw them.
InMemoryResourceProvider
Resource provider over resources held in memory, keyed by canonical name and kind.
NoHostBoxes
Host boxes of a host that has none, every \hostbox renders nothing and emits a warning.
Options
Limits and caching of a Typesetter.
Resource
A resolved resource.
ResourceFontLoader
Loads font files through a ResourceProvider, one key per file in load order.
ResourceRequest
A request for a named resource of a given kind.
TexmfResources
Resource provider over a TeX Live texmf-dist tree by exact file name, through its ls-R index.
Typeset
A typeset fragment and the warnings TeX and the host boxes raised.
Typesetter
Typesets math fragments against one format, keeping the fonts it loaded across fragments.

Enums§

BuildError
Why a format could not be baked.
DiagnosticKind
Kind of a Diagnostic.
FormatError
Why bytes are not a usable format.
MathMode
Math mode a fragment is typeset in.
MathStyle
Math style at a host box’s placement, display style reports as text as TeX’s size does.
ResourceError
Why a resource could not be read.
ResourceKind
Kind of file a request asks for, which picks the suffixes the engine tries and the search path.
TexmfError
Why a TeX Live tree could not be opened.
TypesetError
Why a fragment could not be typeset.

Constants§

FRAGMENT_SOURCE
Source name of the fragment in the fragment’s source map, its spans index the caller’s tex.
TEXMF_ROOT_ENV
Environment variable naming a texmf-dist root, read by TexmfResources::discover.

Traits§

HostBoxes
Answers \hostbox{token} with a box the host lays out, such as a nested editor field.
ResourceProvider
Resolves the TeX inputs, packages, fonts and other files a format build reads.