Struct norad::Layer

pub struct Layer {
    pub color: Option<Color>,
    pub lib: Plist,
    /* private fields */
}

A UFO layer, corresponding to a ‘glyphs’ sub-directory.

Conceptually, a layer is just a collection of glyphs.

Fields

color: Option<Color>

An optional color, specified in the layer’s layerinfo.plist.

lib: Plist

Optional lib data for this layer.

An empty lib is not serialized.

Implementations

impl Layer

pub fn len(&self) -> usize

Returns the number of Glyphs in the layer.

pub fn is_empty(&self) -> bool

Returns true if this layer contains no glyphs.

pub fn is_default(&self) -> bool

Returns true if this layer is the default layer.

The default layer can have any name, but always uses the “glyphs” directory.

pub fn name(&self) -> &Name

Returns the name of the layer.

This can only be mutated through the LayerContents.

pub fn path(&self) -> &Path

Returns the directory path of this layer.

This cannot be mutated; it is either provided when the layer is loaded, or we will create it for you. Maybe this is bad? We can talk about it, if you like.

pub fn entry(&mut self, glyph: Name) -> Entry<'_, Name, Glyph>

Gets the given key’s corresponding entry in the map for in-place manipulation.

pub fn get_glyph(&self, glyph: &str) -> Option<&Glyph>

Returns a reference to the glyph with the given name, if it exists.

pub fn get_glyph_mut(&mut self, glyph: &str) -> Option<&mut Glyph>

Returns a mutable reference to the glyph with the given name, if it exists.

pub fn contains_glyph(&self, name: &str) -> bool

Returns true if this layer contains a glyph with this name.

pub fn insert_glyph(&mut self, glyph: impl Into<Glyph>)

Adds or updates the given glyph.

If the glyph does not previously exist, the filename is calculated from the glyph’s name.

pub fn clear(&mut self)

Remove all glyphs in the layer. Leave color and the lib untouched.

pub fn remove_glyph(&mut self, name: &str) -> Option<Glyph>

Remove the named glyph from this layer and return it, if it exists.

pub fn rename_glyph( &mut self, old: &str, new: &str, overwrite: bool ) -> Result<(), NamingError>

Rename a glyph.

If overwrite is true, and a glyph with the new name exists, it will be replaced.

Returns an error if overwrite is false but a glyph with the new name exists, or if no glyph with the old name exists, or if the new name is not a valid Name.

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

Returns an iterator over the glyphs in this layer.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Glyph>

Returns an iterator over the glyphs in this layer, mutably.

pub fn retain(&mut self, f: impl FnMut(&Name, &mut Glyph) -> bool)

Retains only the elements specified by the predicate.

In other words, remove all pairs (k, v) for which f(&k, &mut v) returns false. The elements are visited in unsorted (and unspecified) order.

pub fn get_path(&self, name: &str) -> Option<&Path>

Returns the path to the .glif file of a given glyph name.

The returned path is relative to the path of the current layer.

Trait Implementations

impl Clone for Layer

fn clone(&self) -> Layer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Layer

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

Formats the value using the given formatter.

impl Default for Layer

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Layer

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Layer