[][src]Struct pest::Position

pub struct Position<'i> { /* fields omitted */ }

A cursor position in a &str which provides useful methods to manually parse that string.

Methods

impl<'i> Position<'i>
[src]

Creates a Position at the start of a &str.

Examples

let start = Position::from_start("");
assert_eq!(start.pos(), 0);

Returns the byte position of this Position as a usize.

Examples

let input = "ab";
let mut start = Position::from_start(input);

assert_eq!(start.pos(), 0);

Creates a Span from two Positions.

Panics

Panics if the positions come from different inputs.

Examples

let input = "ab";
let start = Position::from_start(input);
let span = start.span(&start.clone());

assert_eq!(span.start(), 0);
assert_eq!(span.end(), 0);

Returns the line and column number of this Position.

Examples

enum Rule {}

let input = "\na";
let mut state: Box<pest::ParserState<Rule>> = pest::ParserState::new(input);
let mut result = state.match_string("\na");
assert!(result.is_ok());
assert_eq!(result.unwrap().position().line_col(), (2, 2));

Returns the entire line of the input that contains this Position.

Examples

enum Rule {}

let input = "\na";
let mut state: Box<pest::ParserState<Rule>> = pest::ParserState::new(input);
let mut result = state.match_string("\na");
assert!(result.is_ok());
assert_eq!(result.unwrap().position().line_of(), "a");

Trait Implementations

impl<'i> PartialOrd<Position<'i>> for Position<'i>
[src]

This method returns an ordering between self and other values if one exists. Read more

This method tests less than (for self and other) and is used by the < operator. Read more

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

This method tests greater than (for self and other) and is used by the > operator. Read more

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<'i> Ord for Position<'i>
[src]

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

impl<'i> PartialEq<Position<'i>> for Position<'i>
[src]

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

This method tests for !=.

impl<'i> Clone for Position<'i>
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<'i> Eq for Position<'i>
[src]

impl<'i> Debug for Position<'i>
[src]

Formats the value using the given formatter. Read more

impl<'i> Hash for Position<'i>
[src]

Feeds this value into the given [Hasher]. Read more

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

Auto Trait Implementations

impl<'i> Send for Position<'i>

impl<'i> Sync for Position<'i>

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more