# Struct pest::iterators::Pair

source · [−]

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

Expand description

A matching pair of `Token`s 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 `Token`s 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 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 into_inner(self) -> Pairs<'i, R>ⓘNotable traits for Pairs<'i, R>`impl<'i, R: RuleType> Iterator for Pairs<'i, R> type Item = Pair<'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>ⓘNotable traits for Tokens<'i, R>`impl<'i, R: RuleType> Iterator for Tokens<'i, R> type Item = Token<'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);

## Trait Implementations

source

### impl<'i, R: Clone> Clone for Pair<'i, R>

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl<'i, R: RuleType> Debug for Pair<'i, R>

source

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

Formats the value using the given formatter. Read more

source

### impl<'i, R: RuleType> Display for Pair<'i, R>

source

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

Formats the value using the given formatter. Read more

source

### impl<'i, R: Hash> Hash for Pair<'i, R>

source

#### fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given `Hasher`. Read more

1.3.0 · source

#### fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given `Hasher`. Read more

source

### impl<'i, R: PartialEq> PartialEq<Pair<'i, R>> for Pair<'i, R>

source

#### fn eq(&self, other: &Pair<'i, R>) -> bool

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

1.0.0 · source

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

This method tests for `!=`.

source

### impl<'i, R: Eq> Eq for Pair<'i, R>

## Auto Trait Implementations

### impl<'i, R> RefUnwindSafe for Pair<'i, R> where
R: RefUnwindSafe,

### impl<'i, R> !Send for Pair<'i, R>

### impl<'i, R> !Sync for Pair<'i, R>

### impl<'i, R> Unpin for Pair<'i, R>

### impl<'i, R> UnwindSafe for Pair<'i, R> where
R: RefUnwindSafe,

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

### impl<T> ToString for T where
T: Display + ?Sized,

source

#### default fn to_string(&self) -> String

Converts the given value to a `String`. Read more

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.