Struct pest::Span

source ·
pub struct Span<'i> { /* private fields */ }
Expand description

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

Implementations§

source§

impl<'i> Span<'i>

source

pub fn new(input: &str, start: usize, end: usize) -> Option<Span<'_>>

Attempts to create a new span. Will return None if input[start..end] is an invalid index into input.

§Examples
let input = "Hello!";
assert_eq!(None, Span::new(input, 100, 0));
assert!(Span::new(input, 0, input.len()).is_some());
source

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();
let span = start.span(&end);

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

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();
let span = start.span(&end);

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

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();
let span = start.clone().span(&end);

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

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();
let span = start.span(&end);

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

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();
let span = start.clone().span(&end);

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

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

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

§Examples
enum Rule {}

let input = "abc";
let mut state: Box<pest::ParserState<Rule>> = pest::ParserState::new(input).skip(1).unwrap();
let start_pos = state.position().clone();
state = state.match_string("b").unwrap();
let span = start_pos.span(&state.position().clone());
assert_eq!(span.as_str(), "b");
source

pub fn lines(&self) -> Lines<'_>

Iterates over all lines (partially) covered by this span.

§Examples
enum Rule {}

let input = "a\nb\nc";
let mut state: Box<pest::ParserState<Rule>> = pest::ParserState::new(input).skip(2).unwrap();
let start_pos = state.position().clone();
state = state.match_string("b\nc").unwrap();
let span = start_pos.span(&state.position().clone());
assert_eq!(span.lines().collect::<Vec<_>>(), vec!["b\n", "c"]);

Trait Implementations§

source§

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

source§

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

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> Debug for Span<'i>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'i> Hash for Span<'i>

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, Self: Sized,

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

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

Auto Trait Implementations§

§

impl<'i> RefUnwindSafe for Span<'i>

§

impl<'i> Send for Span<'i>

§

impl<'i> Sync for Span<'i>

§

impl<'i> Unpin for Span<'i>

§

impl<'i> UnwindSafe for Span<'i>

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
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.
source§

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

Performs the conversion.