Struct ilex::token::Digital

pub struct Digital<'lex> { /* private fields */ }

A digital literal.

See rule::Digital for an explanation on what a “digital” is (briefly, they are generalized number literals).

Note that this crate does not provide general number parsing services; parsing numbers is a complex and subtle undertaking, particularly when it comes to floats. For that, consider reading the source code of the rustc_apfloat library, or another softfloat library.

However, we do provide parsing for a few common cases: decimal, binary, octal, and hexadecimal. For floats, this means that the radix of the mantissa is decimal, binary, octal, or hex, the radix of the exponent is decimal, and the base of the exponent is 10 (for decimal) or 2 (for the others).

Implementations

impl<'lex> Digital<'lex>

pub fn radix(self) -> u8

Returns the radix that this digital literal’s digits were parsed in.

pub fn sign(self) -> Option<Sign>

Returns the leading sign of this digital literal, if it had any.

pub fn is_positive(self) -> bool

Checks if there was an explicit positive sign.

pub fn is_negative(self) -> bool

Checks if there was an explicit positive sign.

pub fn sign_span(self) -> Option<SpanId>

Returns the span corresponding to Digital::sign().

pub fn digit_blocks(self) -> impl Iterator<Item = SpanId> + 'lex

Returns the point-separated digit chunks of this digital literal.

pub fn exponents(self) -> impl Iterator<Item = Digital<'lex>>

Returns the exponents of this digital literal, if it any.

Calling exponents() on any of the returned tokens will yield all exponents that follow.

pub fn prefix(self) -> Option<SpanId>

Returns this token’s prefix.

pub fn has_prefix(&self, expected: &str) -> bool

Checks whether this identifier has a particular prefix.

pub fn suffix(&self) -> Option<SpanId>

Returns this token’s suffix.

pub fn has_suffix(&self, expected: &str) -> bool

Checks whether this identifier has a particular prefix.

pub fn to_int<N>(self, range: impl RangeBounds<N>, report: &Report) -> N

where N: Bounded + PartialOrd + FromRadix + Display,

Parses this token as an integer.

More than one digit block, or any exponents, will be diagnosed as an error.

Parse failures become diagnostics, and an unspecified value is provided for a failed integer.

pub fn to_ints<N>(self, range: impl RangeBounds<N>, report: &Report) -> Vec<N>

where N: Bounded + PartialOrd + FromRadix + Display,

Parses the blocks of this digital literal as a sequence of integers; this ignores any exponents that follow.

Parse failures become diagnostics, and an unspecified value is provided for a failed integer.

pub fn to_float<Fp: Parse>( self, range: impl RangeBounds<Fp>, report: &Report, ) -> Result<Fp, Exotic>

Parses this token as a float. Fp can be any of the float types defined in ilex::fp.

This function supports floats with a mantissa radix that is either 10 or a power of two. In the former case, the base for the exponent is 10; otherwise, it is 2.

Any other radix will produce Err. It is highly recommended to unwrap() the result, since a return value of Exotic is almost certainly a bug.

Parse failures and overflow to infinity will generate diagnostics.

pub fn to_float_exact<Fp: Parse>( self, range: impl RangeBounds<Fp>, report: &Report, ) -> Result<Fp, Exotic>

Parses this token as a float, with no rounding. Fp can be any of the float types defined in token::fp.

This function is like Digital::to_float(), except that it also generates a diagnostic if rounding while converting to base 2.

Trait Implementations

impl<'lex> Clone for Digital<'lex>

fn clone(&self) -> Digital<'lex>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Digital<'_>

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

Formats the value using the given formatter.

impl<'lex> From<Digital<'lex>> for Any<'lex>

fn from(value: Digital<'lex>) -> Self

Converts to this type from the input type.

impl Spanned for Digital<'_>

fn span(&self, ctx: &Context) -> Span

Returns the span in this syntax element.

fn file<'ctx>(&self, ctx: &'ctx Context) -> File<'ctx>

Forwards to SpanId::file().

fn start(&self, ctx: &Context) -> usize

Forwards to Span::start().

fn end(&self, ctx: &Context) -> usize

Forwards to Span::end().

fn is_empty(&self, ctx: &Context) -> bool

Forwards to Span::is_empty().

fn len(&self, ctx: &Context) -> usize

Forwards to Span::len().

fn text<'ctx>(&self, ctx: &'ctx Context) -> &'ctx str

Forwards to SpanId::text().

fn comments<'ctx>(&self, ctx: &'ctx Context) -> Comments<'ctx>

Forwards to SpanId::comments().

impl<'lex> Token<'lex> for Digital<'lex>

type Rule = Digital

The token this rule was parsed from.

fn context(self) -> &'lex Context

The context that owns this token.

fn spec(self) -> &'lex Spec

The spec that lexed this token.

fn lexeme(self) -> Lexeme<Self::Rule>

Returns this token’s Lexeme.

fn rule(self) -> Option<&'lex Self::Rule>

The rule inside of Token::spec() that this token refers to.

impl<'lex> TryFrom<Any<'lex>> for Digital<'lex>

type Error = WrongKind

The type returned in the event of a conversion error.

fn try_from(value: Any<'lex>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'lex> Copy for Digital<'lex>