Skip to main content

GenerateWebfontsOptions

Struct GenerateWebfontsOptions 

Source
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: String

Output 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

Source§

fn clone(&self) -> GenerateWebfontsOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for GenerateWebfontsOptions

Source§

fn default() -> GenerateWebfontsOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.