Enum Lit

#[non_exhaustive]
pub enum Lit {
    Bool(LitBool),
    Byte(LitByte),
    Str(LitStr),
    ByteStr(LitByteStr),
    Char(LitChar),
    Number(LitNumber),
}

A literal value,

These are made available by parsing Rune. Custom literals for macros can be constructed through MacroContext::lit.

Examples

Constructing a literal value:

use rune::ast;
use rune::macros;

macros::test(|cx| {
    let lit = cx.lit("hello world")?;
    assert!(matches!(lit, ast::Lit::Str(..)));
    Ok(())
})?;

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bool(LitBool)

A boolean literal

Byte(LitByte)

A byte literal

Str(LitStr)

A string literal

ByteStr(LitByteStr)

A byte string literal

Char(LitChar)

A character literal

Number(LitNumber)

A number literal

Trait Implementations

impl Clone for Lit

fn clone(&self) -> Lit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lit

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

Formats the value using the given formatter.

impl OptionSpanned for Lit

fn option_span(&self) -> Option<Span>

Get the optional span of the type.

impl Parse for Lit

fn parse(p: &mut Parser<'_>) -> Result<Self, Error>

Parse the current item from the parser.

impl PartialEq for Lit

fn eq(&self, other: &Lit) -> 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 Spanned for Lit

fn span(&self) -> Span

Get the span of the type.

impl ToTokens for Lit

fn to_tokens( &self, context: &mut MacroContext<'_, '_, '_>, stream: &mut TokenStream, ) -> Result<()>

Turn the current item into tokens.

impl TryClone for Lit

fn try_clone(&self) -> Result<Self>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.

impl Copy for Lit

impl Eq for Lit

impl StructuralPartialEq for Lit