Struct Span 

pub struct Span { /* private fields */ }

Spans can be created directly using Span::new, or by using the Spanned trait to access the underlying Span of a type.

use quoth::*;
use std::rc::Rc;

let span = Span::new(Rc::new(Source::from_str("Hello, world!")), 0..5);

Spans can be joined together using the Span::join method, which will return a new Span that encompasses both of the original spans. This can be useful for combining spans that were generated from different parts of the same source.

use quoth::*;
use std::rc::Rc;

let source = Rc::new(Source::from_str("Hello, world!"));
let span1 = Span::new(source.clone(), 0..5);
let span2 = Span::new(source.clone(), 7..12);
let encompassing_span = span1.join(&span2).unwrap();
assert_eq!(encompassing_span.source_text(), "Hello, world");

Implementations

impl Span

pub fn blank() -> Span

Returns a blank Span with no source and a zero-length range.

Note that blank Spans are special in that they can be joined with a Span from any Source without error, and will always return the other Span as the result.

pub fn new(source: Rc<Source>, byte_range: Range<usize>) -> Self

Creates a new Span from a Source and a byte range.

pub fn source(&self) -> &Source

Returns the Source that this Span is associated with.

pub fn source_text(&self) -> IndexedSlice<'_>

Returns the text of the Source that this Span is associated with.

pub fn source_path(&self) -> Option<&Path>

Returns the path of the Source that this Span is associated with, if it has one.

pub fn byte_range(&self) -> &Range<usize>

Returns the byte range of this Span, representing the start and end of the span within the Source.

Note that because of UTF-8, the start and end of the range may not correspond with the start and end of a character in the source text.

pub fn start(&self) -> LineCol

Returns the line and column of the start of this Span within the Source.

pub fn end(&self) -> LineCol

Returns the line and column of the end of this Span within the Source.

pub fn source_lines( &self, ) -> impl Iterator<Item = (IndexedSlice<'_>, Range<usize>)> + '_

Returns an iterator over the lines of the Source that this Span is associated with,

pub fn join(&self, other: &Span) -> Result<Span, SpanJoinError>

Joins this Span with another Span, returning a new Span that encompasses both.

If the two spans do not come from the same Source, this method will return an error unless one or more of the spans is Span::blank().

pub fn is_blank(&self) -> bool

Returns whether this Span is blank, i.e. has a zero-length range.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Eq for Span

impl Hash for Span

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

Feeds a slice of this type into the given Hasher.

impl PartialEq for Span

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Spanned for Span

fn span(&self) -> Span

Returns the underlying Span of self.

impl StructuralPartialEq for Span