Struct pest::iterators::Pair

source ·

pub struct Pair<'i, R> { /* private fields */ }

Expand description

A matching pair of Tokens and everything between them.

A matching Token pair is formed by a Token::Start and a subsequent Token::End with the same Rule, with the condition that all Tokens between them can form such pairs as well. This is similar to the brace matching problem in editors.

Implementations§

source §

impl<'i, R: RuleType> Pair<'i, R>

source

pub fn as_rule(&self) -> R

Returns the Rule of the Pair.

§Examples

enum Rule {
    a
}

let input = "";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::a ...
}).unwrap().next().unwrap();

assert_eq!(pair.as_rule(), Rule::a);

source

pub fn as_str(&self) -> &'i str

Captures a slice from the &str defined by the token Pair.

§Examples

enum Rule {
    ab
}

let input = "ab";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::ab ...
}).unwrap().next().unwrap();

assert_eq!(pair.as_str(), "ab");

source

pub fn get_input(&self) -> &'i str

Returns the input string of the Pair.

This function returns the input string of the Pair as a &str. This is the source string from which the Pair was created. The returned &str can be used to examine the contents of the Pair or to perform further processing on the string.

§Examples

enum Rule {
    ab
}

// Example: Get input string from a Pair

let input = "ab";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::ab ...
}).unwrap().next().unwrap();

assert_eq!(pair.as_str(), "ab");
assert_eq!(input, pair.get_input());

source

pub fn into_span(self) -> Span<'i>

👎Deprecated since 2.0.0: Please use as_span instead

Returns the Span defined by the Pair, consuming it.

§Examples

enum Rule {
    ab
}

let input = "ab";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::ab ...
}).unwrap().next().unwrap();

assert_eq!(pair.into_span().as_str(), "ab");

source

pub fn as_span(&self) -> Span<'i>

Returns the Span defined by the Pair, without consuming it.

§Examples

enum Rule {
    ab
}

let input = "ab";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::ab ...
}).unwrap().next().unwrap();

assert_eq!(pair.as_span().as_str(), "ab");

source

pub fn as_node_tag(&self) -> Option<&str>

Get current node tag

source

pub fn into_inner(self) -> Pairs<'i, R> ⓘ

Returns the inner Pairs between the Pair, consuming it.

§Examples

enum Rule {
    a
}

let input = "";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::a ...
}).unwrap().next().unwrap();

assert!(pair.into_inner().next().is_none());

source

pub fn tokens(self) -> Tokens<'i, R> ⓘ

Returns the Tokens for the Pair.

§Examples

enum Rule {
    a
}

let input = "";
let pair = pest::state(input, |state| {
    // generating Token pair with Rule::a ...
}).unwrap().next().unwrap();
let tokens: Vec<_> = pair.tokens().collect();

assert_eq!(tokens.len(), 2);

source