Struct Capture 

pub struct Capture { /* private fields */ }

What to do with the text a capture group matched: give it a scope, run patterns over it, or both.

A scope name converts into a Capture directly, so the common case is .capture(1, "entity.name.function.demo").

Examples

use textmate_lang::{Capture, Grammar, Match, Rule};

let json = Grammar::new("source.demo")
    .pattern(
        Match::new(r#"(import)\s+("[^"]*")"#)
            .capture(1, "keyword.control.import.demo")
            .capture(2, Capture::new().scope("string.quoted.demo").pattern(Rule::include("escapes"))),
    )
    .repository("escapes", textmate_lang::Match::new(r"\\.").scope("constant.character.escape.demo"))
    .to_json()?;
assert!(json.contains(r#""2": {"#));

Implementations

impl Capture

pub fn new() -> Capture

A capture that does nothing until given a scope or patterns.

Examples

use textmate_lang::Capture;

let capture = Capture::new().scope("variable.parameter.demo");
assert_eq!(capture, Capture::from("variable.parameter.demo"));

pub fn scope(self, scope: impl Into<Cow<'static, str>>) -> Capture

Scopes the captured text ("name"). May substitute captured text with $n, ${n:/downcase}, or ${n:/upcase}.

Parameter	Meaning
scope	One scope name, or several separated by single spaces.

Examples

use textmate_lang::{Capture, Grammar, Match};

let json = Grammar::new("source.demo")
    .pattern(Match::new(r"(\w+)!").capture(1, Capture::new().scope("support.function.$1.demo")))
    .to_json()?;
assert!(json.contains("support.function.$1.demo"));

pub fn pattern(self, rule: impl Into<Rule>) -> Capture

Adds a rule run over the captured text ("patterns"), to highlight inside it.

Parameter	Meaning
rule	The rule to add.

Examples

use textmate_lang::{Capture, Grammar, Match};

let json = Grammar::new("source.demo")
    .pattern(
        Match::new(r"@(\w+(?:\.\w+)*)")
            .capture(1, Capture::new().pattern(Match::new(r"\.").scope("punctuation.separator.demo"))),
    )
    .to_json()?;
assert!(json.contains("punctuation.separator.demo"));

Trait Implementations

impl Clone for Capture

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capture

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

Formats the value using the given formatter.

impl Default for Capture

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Capture

impl From<&'static str> for Capture

fn from(scope: &'static str) -> Capture

Converts to this type from the input type.

impl From<Cow<'static, str>> for Capture

fn from(scope: Cow<'static, str>) -> Capture

Converts to this type from the input type.

impl From<String> for Capture

fn from(scope: String) -> Capture

Converts to this type from the input type.

impl PartialEq for Capture

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Capture