Struct ilex::token::Quoted

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

A quoted literal.

Implementations

impl<'lex> Quoted<'lex>

pub fn open(self) -> SpanId

Returns this token’s open delimiter.

pub fn close(self) -> SpanId

Returns this token’s close delimiter.

pub fn delimiters(self) -> (SpanId, SpanId)

Returns this token’s quote delimiters.

pub fn raw_content(self) -> impl Iterator<Item = Content> + 'lex

Returns the raw content of this token.

There are two kinds of content: either a literal span of Unicode scalars (represented as a SpanId pointing to those characters) or a single escape, potentially with some side data.

It is up to the user of the library to decode these two content types into strings. Quoted::to_utf8() helps with the common case of doing this for UTF-8 strings.

pub fn unique_content(self) -> Option<Content>

Returns the unique single Content of this token, if it is unique.

pub fn to_utf8( self, decode_esc: impl FnMut(SpanId, Option<SpanId>, &mut String) ) -> String

Constructs a UTF-8 string in the “obvious way”, using this token and a mapping function for escapes.

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.

Trait Implementations

impl<'lex> Clone for Quoted<'lex>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quoted<'_>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl Spanned for Quoted<'_>

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 Quoted<'lex>

type Rule = Quoted

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 Quoted<'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 Quoted<'lex>