Struct jpar::Span

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

A Span is a set of meta information about the location of a substring.

Implementations

impl<'a> Span<'a>

pub fn whole_content(&self) -> &'a str

The whole content the Span belongs to.

pub fn content(&self) -> &'a str

The content of the Span.

pub fn content_before(&self) -> &'a str

The content before the Span.

pub fn content_after(&self) -> &'a str

The content after the Span.

pub fn start_cursor(&self) -> &Cursor

The start position of the Span in bytes.

pub fn end_cursor(&self) -> &Cursor

The end position of the Span in bytes.

pub fn len(&self) -> usize

The length of the Span in bytes.

pub fn is_empty(&self) -> bool

Whether the span is empty or not.

pub fn char_length(&self) -> usize

The length of the Span in characters.

pub fn lines(&self) -> &'a str

Returns the line(s) in which the Span is contained. If it is composed of more than one line, the result will be all the lines.

Example

let mut reader = Reader::new("This\nis\nthe\nfragment");

// ... prepare the span to contain: "his\nis\nt" ...
let span = reader.substring(&from_cursor, &to_cursor);

// Get its lines.
assert_eq!(span.lines(), "This\nis\nthe");

Trait Implementations

impl<'a> Clone for Span<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Span<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Span<'a>

impl<'a> PartialEq<Span<'a>> for Span<'a>

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

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

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

This method tests for !=.

impl<'a> StructuralEq for Span<'a>

impl<'a> StructuralPartialEq for Span<'a>