Crate ttf_parser[−][src]

Expand description

A high-level, safe, zero-allocation TrueType font parser.

Supports TrueType, OpenType and AAT fonts.

Font parsing starts with a Face.

Features

  • A high-level API for most common properties, hiding all parsing and data resolving logic.
  • A low-level, but safe API to access TrueType tables data.
  • Highly configurable. You can disable most of the features, reducing binary size. You can also parse TrueType tables separately, without loading the whole font/face.
  • Zero heap allocations.
  • Zero unsafe.
  • Zero dependencies.
  • no_std/WASM compatible.
  • Fast.
  • Stateless. All parsing methods are immutable.
  • Simple and maintainable code (no magic numbers).

Safety

  • The library must not panic. Any panic considered as a critical bug and should be reported.
  • The library forbids unsafe code.
  • No heap allocations, so crash due to OOM is not possible.
  • All recursive methods have a depth limit.
  • Technically, should use less than 64KiB of stack in worst case scenario.
  • Most of arithmetic operations are checked.
  • Most of numeric casts are checked.

Modules

avar

An Axis Variations Table implementation.

cbdt

A Color Bitmap Data Table implementation.

cblc

A Color Bitmap Location Table implementation.

cff

A Compact Font Format Table implementation.

cff2

A Compact Font Format 2 Table implementation.

cmap

A Character to Glyph Index Mapping Table implementation.

fvar

A Font Variations Table implementation.

gdef

A Glyph Definition Table implementation.

glyf

A Glyph Data Table implementation.

gpos

A Glyph Positioning Table implementation.

gsub

A Glyph Substitution Table implementation.

gvar

A Glyph Variations Table implementation.

head

A Font Header Table implementation.

hhea

A Horizontal Header Table implementation.

hmtx

A Horizontal/Vertical Metrics Table implementation.

hvar

A Horizontal/Vertical Metrics Variations Table implementation.

kern

A Kerning Table implementation.

loca

An Index to Location Table implementation.

maxp

A Maximum Profile Table implementation.

mvar

A Metrics Variations Table implementation.

name

A Naming Table implementation.

name_id

A list of name ID’s.

opentype_layout

This module contains OpenType Layout tables implementation.

os2

A OS/2 and Windows Metrics Table implementation.

parser

Binary parsing utils.

post

A PostScript Table implementation.

sbix

A Standard Bitmap Graphics Table implementation.

svg

An SVG Table implementation.

vhea

A Vertical Header Table implementation.

vorg

A Vertical Origin Table implementation.

Structs

Face

A font face.

FaceTables

Parsed face tables.

GlyphId

A type-safe wrapper for glyph ID.

LineMetrics

A line metrics.

NormalizedCoordinate

A variation coordinate in a normalized coordinate system.

RasterGlyphImage

A glyph’s raster image.

RawFaceTables

A list of all supported tables as raw data.

Rect

A rectangle.

ScriptMetrics

A script metrics used by subscript and superscript.

Tag

A 4-byte tag.

Variation

A font variation value.

VariationAxis

A variation axis.

Enums

CFFError

A list of errors that can occur during a CFF glyph outlining.

FaceParsingError

A list of font face parsing errors.

PlatformId

A platform ID.

RasterImageFormat

A glyph raster image format.

Style

A face style.

Weight

A face weight.

Width

A face width.

Traits

OutlineBuilder

A trait for glyph outline construction.

Functions

fonts_in_collection

Returns the number of fonts stored in a TrueType font collection.