pub struct GenerateWebfontsOptions {Show 30 fields
pub ascent: Option<f64>,
pub center_horizontally: Option<bool>,
pub center_vertically: Option<bool>,
pub css: Option<bool>,
pub css_dest: Option<String>,
pub css_template: Option<String>,
pub codepoints: Option<HashMap<String, u32>>,
pub css_fonts_url: Option<String>,
pub descent: Option<f64>,
pub dest: String,
pub files: Vec<String>,
pub fixed_width: Option<bool>,
pub format_options: Option<FormatOptions>,
pub html: Option<bool>,
pub html_dest: Option<String>,
pub html_template: Option<String>,
pub font_height: Option<f64>,
pub font_name: Option<String>,
pub font_style: Option<String>,
pub font_weight: Option<String>,
pub ligature: Option<bool>,
pub normalize: Option<bool>,
pub order: Option<Vec<FontType>>,
pub optimize_output: Option<bool>,
pub preserve_aspect_ratio: Option<bool>,
pub round: Option<f64>,
pub start_codepoint: Option<u32>,
pub template_options: Option<Map<String, Value>>,
pub types: Option<Vec<FontType>>,
pub write_files: Option<bool>,
}Expand description
Top-level options controlling webfont generation. Only dest and files
are required; every other field has a sensible default. See the per-field
docs for defaults and units.
Fields§
§ascent: Option<f64>Font ascent in font units. Overrides the value computed from the source glyphs.
center_horizontally: Option<bool>When true, centers each glyph horizontally inside the em-square based
on its bounding box.
center_vertically: Option<bool>When true, centers each glyph vertically inside the em-square based
on its bounding box. Convenience alias for
formatOptions.svg.centerVertically.
css: Option<bool>Whether to generate a CSS file. Defaults to true.
css_dest: Option<String>Output path for the generated CSS file. Defaults to
path.join(dest, fontName + '.css').
css_template: Option<String>Path to a custom Handlebars template for CSS generation. The template
receives the cssContext shape plus any templateOptions keys.
codepoints: Option<HashMap<String, u32>>Explicit Unicode codepoints for specific glyphs, keyed by glyph name.
Glyphs not listed here are auto-assigned starting at startCodepoint.
css_fonts_url: Option<String>URL prefix for font files in the generated CSS. Defaults to the
relative path from cssDest to dest.
descent: Option<f64>Font descent in font units. Overrides the value computed from the source glyphs.
dest: StringOutput directory for generated font files. Required.
files: Vec<String>Paths to the SVG files to include in the font. Required.
fixed_width: Option<bool>When true, produces a monospace font sized to the widest glyph.
format_options: Option<FormatOptions>Per-format option overrides. See FormatOptions.
html: Option<bool>Whether to generate an HTML preview file. Defaults to false.
html_dest: Option<String>Output path for the generated HTML preview file. Defaults to
path.join(dest, fontName + '.html').
html_template: Option<String>Path to a custom Handlebars template for HTML preview generation.
font_height: Option<f64>Explicit output font height in units per em. Overrides the height computed from the source glyphs.
font_name: Option<String>Name of the generated font family; also used as the base name for
output files. Defaults to 'iconfont'.
font_style: Option<String>CSS font-style value for the generated @font-face rule.
font_weight: Option<String>CSS font-weight value for the generated @font-face rule.
ligature: Option<bool>Enable ligature support so each glyph can be referenced by its name as
a text ligature. Defaults to true.
normalize: Option<bool>Scale icons to the height of the tallest icon. Defaults to true.
order: Option<Vec<FontType>>Order of @font-face src: entries in the generated CSS. Every entry
must also appear in types. Defaults to
['eot', 'woff2', 'woff', 'ttf', 'svg'] filtered to the requested
types.
optimize_output: Option<bool>Run an SVG path optimizer over each glyph, trading a small amount of
build time for smaller output bytes. Convenience alias for
formatOptions.svg.optimizeOutput.
preserve_aspect_ratio: Option<bool>Preserve the source viewBox aspect ratio when scaling glyphs into the
em-square. Convenience alias for formatOptions.svg.preserveAspectRatio.
round: Option<f64>SVG path coordinate rounding precision.
start_codepoint: Option<u32>Starting codepoint for auto-assigned glyphs. Defaults to 0xF101.
template_options: Option<Map<String, Value>>Additional key-value pairs merged into the Handlebars template
context for both CSS and HTML rendering. Typical home for
classPrefix and baseSelector.
types: Option<Vec<FontType>>Font formats to generate. Defaults to ['eot', 'woff', 'woff2'].
write_files: Option<bool>Whether to write generated files to disk. Set to false for
in-memory usage. Defaults to true.
Trait Implementations§
Source§impl Clone for GenerateWebfontsOptions
impl Clone for GenerateWebfontsOptions
Source§fn clone(&self) -> GenerateWebfontsOptions
fn clone(&self) -> GenerateWebfontsOptions
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for GenerateWebfontsOptions
impl Default for GenerateWebfontsOptions
Source§fn default() -> GenerateWebfontsOptions
fn default() -> GenerateWebfontsOptions
Auto Trait Implementations§
impl Freeze for GenerateWebfontsOptions
impl RefUnwindSafe for GenerateWebfontsOptions
impl Send for GenerateWebfontsOptions
impl Sync for GenerateWebfontsOptions
impl Unpin for GenerateWebfontsOptions
impl UnsafeUnpin for GenerateWebfontsOptions
impl UnwindSafe for GenerateWebfontsOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<U, T> ToOwnedObj<U> for Twhere
U: FromObjRef<T>,
impl<U, T> ToOwnedObj<U> for Twhere
U: FromObjRef<T>,
Source§fn to_owned_obj(&self, data: FontData<'_>) -> U
fn to_owned_obj(&self, data: FontData<'_>) -> U
T, using the provided data to resolve any offsets.