Struct Compiler

pub struct Compiler<'a, F: FeatureProvider, V: VariationInfo> { /* private fields */ }

A builder-style entry point for the compiler.

This is intended as the principal public API for this crate.

let glyph_map = make_glyph_map();
let my_font_bytes = Compiler::<'_, NopFeatureProvider, NopVariationInfo>::new("path/to/features.fea", &glyph_map)
    .verbose(true)
    .compile_binary().unwrap();

Implementations

impl<'a, F: FeatureProvider, V: VariationInfo> Compiler<'a, F, V>

pub fn new(root_path: impl Into<PathBuf>, glyph_map: &'a GlyphMap) -> Self

Configure a new compilation run with a root source and a glyph map.

In the general case, root_path will be a path to a feature file on disk; however you may compile from memory by passing a custom SourceResolver to the with_resolver method, in which case root_path can be any identifier that your resolver will resolve.

pub fn with_resolver(self, resolver: impl SourceResolver + 'static) -> Self

Provide a custom SourceResolver, for mapping paths to their contents.

pub fn with_variable_info(self, var_info: &'a V) -> Self

Provide VariationInfo, necessary when compiling features for a variable font.

pub fn with_feature_writer(self, feature_writer: &'a F) -> Self

Provide FeatureProvider to provide additional features during compilation

pub fn verbose(self, verbose: bool) -> Self

👎Deprecated since 0.14.1: use print_warnings method instead

Specify verbosity.

When verbose is true, we will print all warnings.

pub fn print_warnings(self, warnings: bool) -> Self

Indicate whether or not warnings should be printed (default is false)

pub fn with_project_root(self, project_root: impl Into<PathBuf>) -> Self

Specify an explicit project root.

This is useful in cases where import resolution is based on an explicit base directory, such as when dealing with certain source formats.

pub fn with_opts(self, opts: Opts) -> Self

Specify additional compiler options.

pub fn compile(self) -> Result<Compilation, CompilerError>

Parse, validate and compile this source.

This returns a Compilation object that contains all of the features and lookups generated during compilation. If you would like to go directly to a binary font, you can use compile_binary instead.

pub fn compile_binary(self) -> Result<Vec<u8>, CompilerError>

Compile to a binary font.