Struct Pair 

pub struct Pair<'i>(/* private fields */);

Implementations

impl<'i> Pair<'i>

pub fn new(pest_pair: Pair<'i, Rule>, source_hash: u64) -> Self

pub fn source_hash(&self) -> u64

pub fn set_source_hash(&mut self, hash: u64)

pub fn pest_pair(&self) -> &Pair<'i, Rule>

pub fn inner(&'i self) -> impl Iterator<Item = Self>

pub fn find<T: Parse>(&'i self, rule: Rule) -> Option<T>

Find an inner pair by rule

Methods from Deref<Target = Pair<'i, Rule>>

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);

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");

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());

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");

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

Get current node tag

pub fn line_col(&self) -> (usize, usize)

Returns the line, col of this pair start.

Trait Implementations

impl<'i> Clone for Pair<'i>

fn clone(&self) -> Pair<'i>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'i> Debug for Pair<'i>

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

Formats the value using the given formatter.

impl From<Pair<'_>> for SrcRef

fn from(pair: Pair<'_>) -> Self

Converts to this type from the input type.

impl SrcReferrer for Pair<'_>

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.

impl<'i> Deref for Pair<'i>

type Target = Pair<'i, Rule>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.