Struct Span 

pub struct Span { /* private fields */ }

a span of start and end Locations in a Buffer

Implementations

impl Span

pub fn new(start: Loc, end: Loc) -> Self

construct a span from two Locations

Panics

if the span is backwards, or if the locations are in different Buffers

pub fn start(&self) -> Loc

get the start of the span

pub fn end(&self) -> Loc

get the start of the span

pub fn is_empty(&self) -> bool

returns whether the span’s length is 0

pub fn len(&self) -> u32

the length in bytes this span covers

pub fn contains(&self, loc: &Loc) -> bool

returns whether this span contains the given Location

pub fn contains_span(&self, subspan: &Self) -> bool

returns whether this span contains the given span

pub fn subspan<B: RangeBounds<u32>>(self, range: B) -> Self

take a sub-span, using a range of this span’s source

Panics

if the sub-span is backwards

pub fn union(&self, with: &Self) -> Self

construct a span that covers both this one and the given one (and anything between them)

Panics

if the spans are in different Buffers

pub fn intersection(&self, with: &Self) -> Option<Self>

construct a span that covers the shared area of both this span and the given one

Panics

if the spans are in different Buffers

pub fn with_len(&self, len: u32) -> Self

construct a Span starting where self starts, with the given length

pub fn same_buf_as(&self, loc: Loc) -> bool

returns whether both locations are in the same Buffer

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, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Span

fn default() -> Span

Returns the “default value” for a type.

impl From<Loc> for Span

fn from(loc: Loc) -> Self

Converts to this type from the input type.

impl From<Range<Loc>> for Span

fn from(span: Range<Loc>) -> Self

Converts to this type from the input type.

impl<Src: BufferSource> From<SrcSpan<Src>> for Span

fn from(src_span: SrcSpan<Src>) -> Self

Converts to this type from the input type.

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<Src: BufferSource> Index<Span> for Buffer<Src>

type Output = str

The returned type after indexing.

fn index(&self, span: Span) -> &Self::Output

Performs the indexing (container[index]) operation.

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 Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span