Struct peresil::StringPoint

pub struct StringPoint<'a> {
    pub s: &'a str,
    pub offset: usize,
}

Tracks the location of parsing in a string, the most common case.

Helper methods are provided to do basic parsing tasks, such as finding literal strings.

Fields

s: &'a str

The portion of the input string to start parsing next

offset: usize

How far into the original string we are

Methods

impl<'a> StringPoint<'a>

pub fn new(s: &'a str) -> StringPoint<'a>

pub fn is_empty(self) -> bool

pub fn to(self, other: StringPoint<'a>) -> &'a str

Slices the string.

pub fn success<E>(self, len: usize) -> Progress<StringPoint<'a>, &'a str, E>

pub fn consume_to(     &self,     l: Option<usize> ) -> Progress<StringPoint<'a>, &'a str, ()>

Advances the point by the number of bytes. If the value is None, then no value was able to be consumed, and the result is a failure.

pub fn consume_literal(     self,     val: &str ) -> Progress<StringPoint<'a>, &'a str, ()>

Advances the point if it starts with the literal.

pub fn consume_identifier<T>(     self,     identifiers: &[Identifier<T>] ) -> Progress<StringPoint<'a>, T, ()> where     T: Clone,

Iterates through the identifiers and advances the point on the first matching identifier.

Trait Implementations

impl<'a> Debug for StringPoint<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for StringPoint<'a>

impl<'a> Clone for StringPoint<'a>

fn clone(&self) -> StringPoint<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> PartialEq for StringPoint<'a>

fn eq(&self, other: &StringPoint<'a>) -> bool

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

fn ne(&self, other: &StringPoint<'a>) -> bool

This method tests for !=.

impl<'a> Eq for StringPoint<'a>

impl<'a> PartialOrd for StringPoint<'a>

fn partial_cmp(&self, other: &StringPoint<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'a> Ord for StringPoint<'a>

fn cmp(&self, other: &StringPoint<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<'a> Point for StringPoint<'a>

fn zero() -> StringPoint<'a>

The initial point