Struct Injection 

pub struct Injection<'a> { /* private fields */ }

A range of a parsed source covered by an injection (LSF2 §12): another language’s content, or a token of this language whose text has structure of its own. See Parse::injections.

Examples

use lang_forge::Language;

// `$name.field` inside a string is parsed by the `path` rule.
let lang = Language::from_lsf(
    "[sketch]\nformat = 2\n[language]\nname = \"s\"\nversion = \"1.0.0\"\n\
     [lexer.strings.DQ]\nopen = '\"'\nembedded = [{ token = \"DQ_VAR\", regex = '\\$[a-z]+(\\.[a-z]+)*', parse = \"path\" }]\n\
     interpolate = [{ open = \"{\", close = \"}\", rule = \"path\" }]\n\
     [lexer.tokens]\nVAR = { regex = '\\$[a-z]+' }\n\
     [rules]\nfile = \"DQ*\"\npath = \"VAR ('.' IDENT)*\"\n",
)?;
let src = "\"hello $user.name\"";
let parse = lang.parse(src);
let injection = &parse.injections()[0];
assert_eq!((injection.id(), injection.language(), injection.is_editor()), ("DQ_VAR", "self", false));
assert_eq!(injection.span().start().to_usize(), 7);
let tree = injection.tree().expect("a self-injection is parsed");
assert_eq!(lang.kind_name(*tree.kind()), "path");
assert_eq!(tree.text(src), Some("$user.name"));

Implementations

impl<'a> Injection<'a>

pub fn id(&self) -> &'a str

The injection’s id from [injections], or the token class’s name for an embedded token with parse.

pub fn language(&self) -> &'a str

The injected language: "self", or the name the sketch gives.

pub fn span(&self) -> Span

The range of the source the injection covers.

pub fn tree(&self) -> Option<&Node<Kind>>

The injected tree, for a self-injection; None for another language or an editor-resolved injection (and for one nested more than 16 levels deep, which a warning reports).

pub fn is_editor(&self) -> bool

Whether the sketch leaves this injection to editors (resolve = "editor").

Trait Implementations

impl<'a> Clone for Injection<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Injection<'a>

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

Formats the value using the given formatter.