Struct pest::Span

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

A struct of a span over a &str. It is created from either two Positions or from a Pair.

Methods

impl<'i> Span<'i>

pub fn start(&self) -> usize

Returns the Span's start byte position as a usize.

Examples

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

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

pub fn end(&self) -> usize

Returns the Span's end byte position as a usize.

Examples

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

assert_eq!(span.end(), 2);

pub fn start_pos(&self) -> Position<'i>

Returns the Span's start Position.

Examples

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

assert_eq!(span.start_pos(), start);

pub fn end_pos(&self) -> Position<'i>

Returns the Span's end Position.

Examples

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

assert_eq!(span.end_pos(), end);

pub fn split(self) -> (Position<'i>, Position<'i>)

Splits the Span into a pair of Positions.

Examples

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

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

pub fn as_str(&self) -> &'i str

Captures a slice from the &str defined by the Span.

Examples

let input = "abc";
let start = Position::from_start(input).skip(1).unwrap();
let end = start.clone().match_string("b").unwrap();
let span = start.span(&end);

assert_eq!(span.as_str(), "b");

Trait Implementations

impl<'i> Debug for Span<'i>

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

Formats the value using the given formatter.

impl<'i> Clone for Span<'i>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'i> PartialEq for Span<'i>

fn eq(&self, other: &Span<'i>) -> bool

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

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

This method tests for !=.

impl<'i> Eq for Span<'i>

impl<'i> PartialOrd for Span<'i>

fn partial_cmp(&self, other: &Span<'i>) -> 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<'i> Ord for Span<'i>

fn cmp(&self, other: &Span<'i>) -> 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<'i> Hash for Span<'i>

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

Feeds this value into the given [Hasher].

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

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