Struct ucd_parse::UnicodeData

pub struct UnicodeData {
    pub codepoint: Codepoint,
    pub name: String,
    pub general_category: String,
    pub canonical_combining_class: u8,
    pub bidi_class: String,
    pub decomposition: UnicodeDataDecomposition,
    pub numeric_type_decimal: Option<u8>,
    pub numeric_type_digit: Option<u8>,
    pub numeric_type_numeric: Option<UnicodeDataNumeric>,
    pub bidi_mirrored: bool,
    pub unicode1_name: String,
    pub iso_comment: String,
    pub simple_uppercase_mapping: Option<Codepoint>,
    pub simple_lowercase_mapping: Option<Codepoint>,
    pub simple_titlecase_mapping: Option<Codepoint>,
}

Represents a single row in the UnicodeData.txt file.

These fields were taken from UAX44, Table 9, as part of the documentation for the UnicodeData.txt file.

Fields

codepoint: Codepoint

The codepoint corresponding to this row.

name: String

The name of this codepoint.

general_category: String

The "general category" of this codepoint.

canonical_combining_class: u8

The class of this codepoint used in the Canonical Ordering Algorithm.

Note that some classes map to a particular symbol. See UAX44, Table 15.

bidi_class: String

The bidirectional class of this codepoint.

Possible values are listed in UAX44, Table 13.

decomposition: UnicodeDataDecomposition

The decomposition mapping for this codepoint. This includes its formatting tag (if present).

numeric_type_decimal: Option<u8>

A decimal numeric representation of this codepoint, if it has the property Numeric_Type=Decimal.

numeric_type_digit: Option<u8>

A decimal numeric representation of this codepoint, if it has the property Numeric_Type=Digit. Note that while this field is still populated for existing codepoints, no new codepoints will have this field populated.

numeric_type_numeric: Option<UnicodeDataNumeric>

A decimal or rational numeric representation of this codepoint, if it has the property Numeric_Type=Numeric.

bidi_mirrored: bool

A boolean indicating whether this codepoint is "mirrored" in bidirectional text.

unicode1_name: String

The "old" Unicode 1.0 or ISO 6429 name of this codepoint. Note that this field is empty unless it is significantly different from the name field.

iso_comment: String

The ISO 10464 comment field. This no longer contains any non-NULL values.

simple_uppercase_mapping: Option<Codepoint>

This codepoint's simple uppercase mapping, if it exists.

simple_lowercase_mapping: Option<Codepoint>

This codepoint's simple lowercase mapping, if it exists.

simple_titlecase_mapping: Option<Codepoint>

This codepoint's simple titlecase mapping, if it exists.

Methods

impl UnicodeData

pub fn is_range_start(&self) -> bool

Returns true if and only if this record corresponds to the start of a range.

pub fn is_range_end(&self) -> bool

Returns true if and only if this record corresponds to the end of a range.

Trait Implementations

impl Clone for UnicodeData

fn clone(&self) -> UnicodeData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnicodeData

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

Formats the value using the given formatter.

impl Default for UnicodeData

fn default() -> UnicodeData

Returns the "default value" for a type.

impl Display for UnicodeData

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

Formats the value using the given formatter.

impl Eq for UnicodeData

impl FromStr for UnicodeData

type Err = Error

The associated error which can be returned from parsing.

fn from_str(line: &str) -> Result<UnicodeData, Error>

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

impl PartialEq<UnicodeData> for UnicodeData

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

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

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

This method tests for !=.

impl StructuralEq for UnicodeData

impl StructuralPartialEq for UnicodeData

impl UcdFile for UnicodeData

fn relative_file_path() -> &'static Path

The file path corresponding to this file, relative to the UCD directory.

fn file_path<P: AsRef<Path>>(ucd_dir: P) -> PathBuf

The full file path corresponding to this file given the UCD directory path.

fn from_dir<P: AsRef<Path>>(
    ucd_dir: P
) -> Result<UcdLineParser<File, Self>, Error>

Create an iterator over each record in this UCD file.

impl UcdFileByCodepoint for UnicodeData

fn codepoints(&self) -> CodepointIter

Returns the codepoints associated with this record.