Struct GlifComponents

pub struct GlifComponents {
    pub root: String,
    pub vec: Vec<GlifComponent>,
    pub uniques: HashSet<String>,
}

A container meant for yelding a Forest<Component<PD>>.

Please see impl From<GlifComponents> for Result<Forest<Component<PD>>, GlifParserError>.

Fields

root: String

vec: Vec<GlifComponent>

uniques: HashSet<String>

Implementations

impl GlifComponents

pub fn new() -> Self

impl GlifComponents

Builds a tree of components in a recursive manner. It takes a mutable reference to a HashSet called uniques, which keeps track of the unique component names seen so far in the current subtree. This prevents cycles from occurring.

If a loop is found in the tree (for example, gershayim refers to grave refers to grave), an error is returned with the appropriate message. The error type is GlifParserError::GlifComponentsCyclical, which takes a formatted string to provide more details about the error.

pub fn build_component_tree<PD: PointData>( &mut self, component: Component<PD>, ) -> Result<Tree<Component<PD>>, GlifParserError>

You should not need to call this function directly; see § Conversion.

Trait Implementations

impl Clone for GlifComponents

fn clone(&self) -> GlifComponents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlifComponents

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

Formats the value using the given formatter.

impl Default for GlifComponents

fn default() -> GlifComponents

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlifComponents

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<PD: PointData> From<GlifComponents> for Result<Forest<Component<PD>>, GlifParserError>

Conversion

This impl builds up a forest of trees for a glyph’s components. Imagine a hungarumlaut (˝).

This character may be built of glyph components, as such:

hungarumlaut
   /    \
  /      \
grave  grave
  |      |
acute  acute

This function will give you a Forest of both of the sub-trees. (Forest<Component>). The elements of a Forest are Tree<Component>. For safety reasons, this function cannot always return a Forest. Sometimes, .glif files can be malformed, containing components which refer to themselves or to components higher up the tree.

fn from(glifcs: GlifComponents) -> Self

Converts to this type from the input type.

impl PartialEq for GlifComponents

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for GlifComponents

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GlifComponents