Enum Symbol

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

The master file representation of a single character.

Variants

Char(char)

An unescaped Unicode character.

SimpleEscape(char)

An escape character by simply being backslashed.

DecimalEscape(u8)

An escaped character using the decimal escape sequence.

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_byte(ch: u8) -> Self

Provides the best symbol for a byte.

The function will use simple escape sequences for spaces, quotes, backslashs, and semicolons. It will leave all other printable ASCII characters unescaped and decimal escape all remaining byte value.

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

Converts the symbol into a byte 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 a byte or an error otherwise. 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.

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

Converts the symbol representing a digit into its integer value.

pub fn push_to_buf(self, buf: &mut BytesMut) -> Result<(), BadSymbol>

Pushes a symbol that is a byte to the end of a byte buffer.

If the symbol is a byte as per the rules described in into_byte, it will be pushed to the end of buf, reserving additional space if there isn’t enough space remaining.

pub fn is_word_char(self) -> bool

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

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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 From<char> for Symbol

fn from(ch: char) -> Symbol

Converts to this type from the input type.

impl PartialEq for Symbol

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

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

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 Copy for Symbol

impl Eq for Symbol

impl StructuralPartialEq for Symbol