Enum domain::base::str::Symbol

pub enum Symbol {
    Char(char),
    SimpleEscape(char),
    DecimalEscape(u8),
}

The master file representation of a single character.

This is either a regular character or an escape sequence. See the variants for more details.

Variants

Char(char)

An unescaped Unicode character.

SimpleEscape(char)

A character escaped via a preceding backslash.

DecimalEscape(u8)

A raw octet escaped using the decimal escape sequence.

This escape sequence consists of a backslash followed by exactly three decimal digits with the value of the octets.

Implementations

impl Symbol

pub fn from_chars<C>(chars: C) -> Result<Option<Self>, SymbolError> where
    C: IntoIterator<Item = char>, 

Reads a symbol from a character source.

Returns the next symbol in the source, Ok(None) if the source has been exhausted, or an error if there wasn’t a valid symbol.

pub fn from_octet(ch: u8) -> Self

Provides the best symbol for an octet.

The function will use the simple escape sequence for octet values that represent ASCII spaces, quotes, backslashes, and semicolons and the plain ASCII value for all other printable ASCII characters. Any other value is escaped using the decimal escape sequence.

pub fn into_octet(self) -> Result<u8, BadSymbol>

Converts the symbol into an octet if it represents one.

Both domain names and character strings operate on bytes instead of (Unicode) characters. These bytes can be represented by printable ASCII characters (that is, U+0020 to U+007E), both plain or through a simple escape, or by a decimal escape.

This method returns such an octet or an error if the symbol doesn’t have value representing an octet. Note that it will succeed for an ASCII space character U+0020 which may be used as a word separator in some cases.

pub fn into_char(self) -> Result<char, BadSymbol>

Converts the symbol into a char.

This will fail for a decimal escape sequence which doesn’t actually represent a character.

pub fn into_digit(self, base: u32) -> Result<u32, BadSymbol>

Converts the symbol representing a digit into its integer value.

pub fn is_word_char(self) -> bool

Returns whether the symbol can occur as part of a word.

This is true apart for unescaped ASCII space and horizontal tabs, opening and closing parantheses, the semicolon, and double quote.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Symbol

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl From<char> for Symbol

fn from(ch: char) -> Symbol

Performs the conversion.

impl PartialEq<Symbol> for Symbol

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

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

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

This method tests for !=.

impl StructuralEq for Symbol

impl StructuralPartialEq for Symbol