[][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]

Attempts to create a new Position at the given position. If the specified position is an invalid index, or the specified position is not a valid UTF8 boundary, then None is returned.

Examples

let cheart = '💖';
let heart = "💖";
assert_eq!(Position::new(heart, 1), None);
assert_ne!(Position::new(heart, cheart.len_utf8()), None);

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> Ord for Position<'i>
[src]

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 !=.

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

Performs copy-assignment from source. Read more

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

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

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> Debug for Position<'i>
[src]

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

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> From for T
[src]

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

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

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.

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

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

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.

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