Enum domain::base::scan::Symbol

source ·
pub enum Symbol {
    Char(char),
    SimpleEscape(u8),
    DecimalEscape(u8),
}
Expand description

The zone 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(u8)

A character escaped via a preceding backslash.

This escape sequence is only allowed for printable ASCII characters.

§

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§

source§

impl Symbol

source

pub fn from_chars<C: Iterator<Item = char>>( chars: &mut C, ) -> Result<Option<Self>, SymbolCharsError>

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.

source

pub fn from_slice_index( octets: &[u8], pos: usize, ) -> Result<Option<(Symbol, usize)>, SymbolOctetsError>

Reads a symbol from the given position in an octets slice.

Returns the symbol and the index of the end of the symbol in the slice.

source

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.

source

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.

source

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

Converts the symbol into an octet if it is printable ASCII.

This is similar to into_octet but returns an error when the resulting octet is not a printable ASCII character, i.e., an octet of value 0x20 up to and including 0x7E.

source

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.

source

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

Converts the symbol representing a digit into its integer value.

source

pub fn is_word_char(self) -> bool

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

This is true for all symbols other than unescaped ASCII space and horizontal tabs, opening and closing parentheses, semicolon, and double quote.

Trait Implementations§

source§

impl Clone for Symbol

source§

fn clone(&self) -> Symbol

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Symbol

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Symbol

source§

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

Formats the value using the given formatter. Read more
source§

impl From<Symbol> for EntrySymbol

source§

fn from(symbol: Symbol) -> Self

Converts to this type from the input type.
source§

impl From<char> for Symbol

source§

fn from(ch: char) -> Symbol

Converts to this type from the input type.
source§

impl PartialEq for Symbol

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Copy for Symbol

source§

impl Eq for Symbol

source§

impl StructuralPartialEq for Symbol

Auto Trait Implementations§

§

impl Freeze for Symbol

§

impl RefUnwindSafe for Symbol

§

impl Send for Symbol

§

impl Sync for Symbol

§

impl Unpin for Symbol

§

impl UnwindSafe for Symbol

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

§

type Error = <Target as OctetsFrom<Source>>::Error

source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more