Enum WrittenUnit 

#[non_exhaustive]
pub enum WrittenUnit {
    A,
    Aa,
    B,
    B2,
    C,
    Ch,
    Cr,
    D,
    Dd,
    F,
    G,
    Gx,
    H,
    Hr,
    Hx,
    I,
    Ix,
    J,
    K,
    K2,
    L,
    M,
    Mvs,
    N,
    Nirugu,
    O,
    P,
    R,
    Rh,
    S,
    Sh,
    Sz,
    T,
    U,
    Ue,
    Ux,
    W,
    Y,
    Z,
    Zr,
    Zwj,
}

A written unit: an opaque glyph-form identifier produced by shaping (see docs/data-format.md). The structural tokens Mvs, Nirugu and Zwj are members too: they appear verbatim in Shaper::shape output, exactly as the Python implementation emits them.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

A

Written unit A.

Aa

Written unit Aa.

B

Written unit B.

B2

Written unit B2.

C

Written unit C.

Ch

Written unit Ch.

Cr

Written unit Cr.

D

Written unit D.

Dd

Written unit Dd.

F

Written unit F.

G

Written unit G.

Gx

Written unit Gx.

H

Written unit H.

Hr

Written unit Hr.

Hx

Written unit Hx.

I

Written unit I.

Ix

Written unit Ix.

J

Written unit J.

K

Written unit K.

K2

Written unit K2.

L

Written unit L.

M

Written unit M.

Mvs

Structural token: Mongolian vowel separator U+180E (NNBSP U+202F is folded into it).

N

Written unit N.

Nirugu

Structural token: nirugu U+180A, the visible stem extender.

O

Written unit O.

P

Written unit P.

R

Written unit R.

Rh

Written unit Rh.

S

Written unit S.

Sh

Written unit Sh.

Sz

Written unit Sz.

T

Written unit T.

U

Written unit U.

Ue

Written unit Ue.

Ux

Written unit Ux.

W

Written unit W.

Y

Written unit Y.

Z

Written unit Z.

Zr

Written unit Zr.

Zwj

Structural token: zero width joiner U+200D.

Implementations

impl WrittenUnit

pub const ALL: [WrittenUnit; 41]

Every variant, in declaration (sorted contract-name) order.

pub const fn as_str(self) -> &'static str

The contract name used by the Python API, the CLI and the data files.

Examples found in repository

examples/compare.rs (line 185)

fn joined(units: &[WrittenUnit]) -> String {
    if units.is_empty() {
        return "∅".to_owned();
    }
    units
        .iter()
        .map(|unit| unit.as_str())
        .collect::<Vec<_>>()
        .join("+")
}

pub const fn is_structural(self) -> bool

true for the structural tokens Mvs, Nirugu and Zwj.

Trait Implementations

impl Clone for WrittenUnit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WrittenUnit

impl Debug for WrittenUnit

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

Formats the value using the given formatter.

impl Display for WrittenUnit

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

Formats the value using the given formatter.

impl Eq for WrittenUnit

impl FromStr for WrittenUnit

type Err = Error

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<WrittenUnit, Error>

Parses a string s to return a value of this type.

impl Hash for WrittenUnit

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WrittenUnit

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for WrittenUnit

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WrittenUnit

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for WrittenUnit