HarfRust

HarfRust is a Rust port of HarfBuzz text shaping engine. See Major changes below for major differences between HarfRust and HarfBuzz.

HarfRust started as a fork of RustyBuzz to explore porting from ttf-parser to read-fonts to avoid shipping (and maintaining) multiple implementations of core font parsing for skrifa consumers. Further context in https://github.com/googlefonts/fontations/issues/956.

Matches HarfBuzz v14.3.1.

Why?

https://github.com/googlefonts/oxidize outlines Google Fonts motivations to try to migrate font production and consumption to Rust.

Major changes

• No font size property. Shaping is always using UnitsPerEm. You should scale the result manually.
• Most of the font loading and parsing is done using read-fonts.
• HarfRust doesn't provide any integration with external libraries, so no FreeType, CoreText, or Uniscribe/DirectWrite font-loading integration, and no ICU, or GLib Unicode-functions integration, as well as no graphite2 library support.
• No graphite font support.

Conformance

The following conformance issues need to be fixed:

• HarfRust for the most part passes the HarfBuzz test and fuzzing suites, but there are some known issues. See HARFBUZZ.md for details.
• Malformed fonts will cause an error. HarfBuzz uses fallback/dummy shaper in this case.
• Experimental HarfBuzz features like most of the boring-expansion-spec are not supported yet.

Performance

HarfRust is less than 25% slower than HarfBuzz on most common fonts. For a comparison see this spreadsheet. You can run cargo bench to see the performance of HarfRust on your machine.

Notes about the port

HarfRust is not a full port of HarfBuzz. HarfBuzz (C++ edition) can roughly be split into 6 parts:

1. shaping, ported to HarfRust
2. Unicode routines, ported to HarfRust
3. font parsing, handled by read-fonts
4. subsetting, handled by skera
5. custom containers and utilities (HarfBuzz doesn't use C++ standard library), reimplemented in fontations where appropriate (e.g. int set)
6. glue for system/3rd party libraries, not ported

Safety

The library is completely safe.

There are no unsafe in this library and in most of its dependencies (excluding bytemuck).

Releasing

• Edit CHANGELOG.md following the conventions in that file, at least
  • Add information about which HarfBuzz release is tracked
  • Update diff links at the bottom
  • Determine diff from previous release and
  • Summarize changes
  • Determine new version number according to SemVer Note that increasing a dependency version to a new major release means a breaking change for this crate.
• Update Cargo.toml release version following SemVer, in TWO places
• Run cargo-semver-checks:
  • cargo semver-checks check-release -p harfrust
  • cargo semver-checks check-release -p hr-shape
• Commit to a branch and file a PR
• Get PR reviewed and land
• Pull/Rebase local main checkout, then
  • git tag release version, e.g. git tag 0.7.1
  • git push origin <tag>
• Then cargo publish:
  • IMPORTANT: Prefer to publish from an OS that supports symlinks. When publishing from an OS that does not understand symlinks produced by git, version files in crates.io might turn into text files showing the symlink's target.
  • cargo publish -p harfrust
  • cargo publish -p hr-shape
• Go to GitHub releases page, copy commit message and release tagged version.

Developer documents

For notes on the backporting process of HarfBuzz code, see docs/backporting.md.

For notes on generating state machine using ragel, see docs/ragel.md.

The following HarfBuzz studies are relevant to HarfRust development:

• 2025 - Introducing HarfRust
• 2025 – Caching

License

HarfRust is licensed under the MIT license.

HarfBuzz is licensed under the Old MIT