Struct norad::Font

#[non_exhaustive]
pub struct Font {
    pub meta: MetaInfo,
    pub font_info: FontInfo,
    pub layers: LayerSet,
    pub lib: Plist,
    pub groups: Groups,
    pub kerning: Kerning,
    pub features: String,
    pub data_request: DataRequest,
    pub data: DataStore,
    pub images: ImageStore,
}

A Unified Font Object.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

meta: MetaInfo

font_info: FontInfo

layers: LayerSet

lib: Plist

groups: Groups

kerning: Kerning

features: String

data_request: DataRequest

data: DataStore

images: ImageStore

Implementations

impl Font

pub fn new() -> Self

Create a new, empty Font object.

pub fn load<P: AsRef<Path>>(path: P) -> Result<Font, Error>

Attempt to load a font object from a file.

path must point to a directory with the structure described in v3 of the Unified Font Object spec.

Note

This will consume the public.objectLibs key in the global lib and in glyph libs and assign object libs found therein to global guidelines and glyph objects with the matching identifier, respectively.

pub fn load_requested_data(
    path: impl AsRef<Path>,
    request: DataRequest
) -> Result<Font, Error>

Attempt to load the requested elements of a font object from a file.

pub fn save(&self, path: impl AsRef<Path>) -> Result<(), Error>

Attempt to save this UFO to the given path, overriding any existing contents.

This may fail; instead of saving directly to the target path, it is a good idea to save to a temporary location and then move that to the target path if the save is successful.

This will fail if either the global or any glyph lib contains the public.objectLibs key, as object lib management is done automatically.

pub fn save_with_options(
    &self,
    path: impl AsRef<Path>,
    options: &WriteOptions
) -> Result<(), Error>

Attempt to save the UFO, using the provided WriteOptions.

pub fn default_layer(&self) -> &Layer

Returns a reference to the default layer.

pub fn default_layer_mut(&mut self) -> &mut Layer

Returns a mutable reference to the default layer.

pub fn iter_layers(&self) -> impl Iterator<Item = &Layer>

Returns an iterator over all layers in this font object.

pub fn iter_names(&self) -> impl Iterator<Item = GlyphName> + '_

Returns an iterator over all the glyphs in the default layer.

pub fn get_glyph<K>(&self, key: &K) -> Option<&Arc<Glyph>> where
    GlyphName: Borrow<K>,
    K: Ord + ?Sized, 

Returns a reference to the glyph with the given name (in the default layer).

pub fn get_glyph_mut<K>(&mut self, key: &K) -> Option<&mut Glyph> where
    GlyphName: Borrow<K>,
    K: Ord + ?Sized, 

Returns a mutable reference to the glyph with the given name, IN THE DEFAULT LAYER, if it exists.

pub fn glyph_count(&self) -> usize

Returns the total number of glyphs in the default layer.

pub fn guidelines(&self) -> &[Guideline]

Return the font’s global guidelines, stored in FontInfo.

pub fn guidelines_mut(&mut self) -> &mut Vec<Guideline>

Returns a mutable reference to the font’s global guidelines.

These will be created if they do not already exist.

Trait Implementations

impl Clone for Font

fn clone(&self) -> Font

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Font

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Font

fn default() -> Font

Returns the “default value” for a type.

impl PartialEq<Font> for Font

fn eq(&self, other: &Font) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Font) -> bool

This method tests for !=.

impl StructuralPartialEq for Font