Struct rune::ast::Label

#[non_exhaustive]
pub struct Label {
    pub span: Span,
    pub source: LitSource,
}

A label, like 'foo.

Custom labels are constructed in macros using MacroContext::label.

Examples

Constructing a label:

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

MacroContext::test(|ctx| {
    let lit = ctx.label("foo");
    assert!(matches!(lit, ast::Label { .. }))
});

Example labels:

use rune::{ast, testing};

testing::roundtrip::<ast::Label>("'foo");
testing::roundtrip::<ast::Label>("'barify42");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

span: Span

The token of the label.

source: LitSource

The source of the label.

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl Parse for Label

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

Parse the current item from the parser.

impl PartialEq<Label> for Label

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Peek for Label

fn peek(p: &mut Peeker<'_>) -> bool

Peek the parser for the given token.

impl<'a> Resolve<'a> for Label

type Output = &'a str

The output type being resolved into.

fn resolve(&self, ctx: ResolveContext<'a>) -> Result<&'a str, ResolveError>

Resolve the value from parsed AST.

impl Spanned for Label

fn span(&self) -> Span

Get the span of the type.

impl ToTokens for Label

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

Turn the current item into tokens.

impl Copy for Label

impl Eq for Label

impl StructuralEq for Label

impl StructuralPartialEq for Label