Struct BeginWhile

Source

pub struct BeginWhile { /* private fields */ }

Expand description

A region that opens at a begin match and continues, line by line, for as long as a while pattern matches at the start of each following line ("begin"/"while"), as Markdown block quotes and lists do.

Numbered back-references in while stand for the text begin groups captured.

§Examples

use textmate_lang::{BeginWhile, Grammar, Rule};

let quote = BeginWhile::new(r"^\s*(>) ?", r"^\s*(>) ?")
    .scope("markup.quote.demo")
    .begin_capture(1, "punctuation.definition.quote.demo")
    .while_capture(1, "punctuation.definition.quote.demo")
    .pattern(Rule::include_self());
let json = Grammar::new("text.demo").pattern(quote).to_json()?;
assert!(json.contains(r#""while": "^\\s*(>) ?""#));

Implementations§

Source §

impl BeginWhile

Source

pub fn new( begin: impl Into<Cow<'static, str>>, while_: impl Into<Cow<'static, str>>, ) -> BeginWhile

A region opened by begin and continued while while_ matches.

Parameter	Meaning
`begin`	The pattern that opens the region.
`while_`	The pattern each following line must start with; `\n` back-references name `begin` groups.

§Examples

use textmate_lang::{BeginWhile, Grammar};

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^(\\s{4})", "^\\1").scope("markup.raw.block.demo"))
    .to_json()?;
assert!(json.contains(r#""while": "^\\1""#));

Source

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

Scopes the whole region ("name"). $n substitutions name begin groups.

§Examples

use textmate_lang::{BeginWhile, Grammar};

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^>", "^>").scope("markup.quote.demo"))
    .to_json()?;
assert!(json.contains("markup.quote.demo"));

Source

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

Scopes the region without the begin match ("contentName").

§Examples

use textmate_lang::{BeginWhile, Grammar};

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^>", "^>").content_scope("markup.quote.content.demo"))
    .to_json()?;
assert!(json.contains(r#""contentName": "markup.quote.content.demo""#));

Source

pub fn capture(self, group: u32, capture: impl Into<Capture>) -> BeginWhile

Sets capture group for both begin and while ("captures").

§Examples

use textmate_lang::{BeginWhile, Grammar};

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^(>)", "^(>)").capture(1, "punctuation.demo"))
    .to_json()?;
assert!(json.contains(r#""captures": {"#));

Source

pub fn begin_capture( self, group: u32, capture: impl Into<Capture>, ) -> BeginWhile

Sets capture group of begin ("beginCaptures").

§Examples

use textmate_lang::{BeginWhile, Grammar};

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^(>)", "^>").begin_capture(1, "punctuation.demo"))
    .to_json()?;
assert!(json.contains(r#""beginCaptures": {"#));

Source

pub fn while_capture( self, group: u32, capture: impl Into<Capture>, ) -> BeginWhile

Sets capture group of while ("whileCaptures").

§Examples

use textmate_lang::{BeginWhile, Grammar};

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^>", "^(>)").while_capture(1, "punctuation.demo"))
    .to_json()?;
assert!(json.contains(r#""whileCaptures": {"#));

Source

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

Adds a rule that applies inside the region ("patterns").

§Examples

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

let json = Grammar::new("text.demo")
    .pattern(BeginWhile::new("^>", "^>").pattern(Match::new(r"\*\*").scope("markup.bold.demo")))
    .to_json()?;
assert!(json.contains("markup.bold.demo"));