Struct locspan::Span

pub struct Span { /* private fields */ }

Range of bytes in a source file.

This is very similar to the Range<usize> type unless it is not an iterator and implements the Copy trait.

Implementations

impl Span

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

Creates a new Span by providing the index of its starting byte (included) and ending byte (excluded).

If the end position is lower than the start position, then the start position is used as ending position instead.

pub fn len(&self) -> usize

Size of the span in bytes.

pub fn is_empty(&self) -> bool

Checks if the span is empty.

Returns true if the start position is equal to the end position, and false otherwise. The end position can never be lower than the start position.

pub fn start(&self) -> usize

Returns the index of the first byte in the span.

pub fn end(&self) -> usize

Returns the index of the first byte after the span.

This can never be lower than Self::start.

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

Returns the range of bytes inside the span.

pub fn contains(&self, index: usize) -> bool

Checks if the given byte index if included in the span.

pub fn set_start(&mut self, start: usize)

Sets the index of the first byte in the span.

If the end position of the span is lower that start, then it is also changed into start.

pub fn set_end(&mut self, end: usize)

Sets the index of the first byte after the span.

If end is lower that the start position, the start position is used instead.

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

Computes the union of two spans.

If the two spans do not overlap, all the positions in between will be included in the resulting span.

pub fn append(&mut self, other: Self)

Extend this span to include other.

This is the in-place version of union.

pub fn inter(&self, other: Self) -> Self

Computes the intersection of two spans.

If the two spans do not overlap, then the empty span located at the start of the most advanced span (maximum of the start of the two spans) is returned.

pub fn clear(&mut self)

Clear the span by moving its start position to its end position.

pub fn next(&self) -> Self

Return the “next” span: the empty span starting at the end of this one.

pub fn push(&mut self, count: usize)

Push count bytes to the span.

Move its end position by count.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy 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 Default for Span

fn default() -> Span

Returns the “default value” for a type.

impl From<Range<usize>> for Span

fn from(range: Range<usize>) -> Self

Converts to this type from the input type.

impl From<Span> for Range<usize>

fn from(span: Span) -> Self

Converts to this type from the input type.

impl From<usize> for Span

fn from(pos: usize) -> 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, 

Feeds a slice of this type into the given Hasher.

impl Index<Span> for str

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<Span> for String

type Output = str

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<Span> for str

fn index_mut(&mut self, span: Span) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Span> for String

fn index_mut(&mut self, span: Span) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Span

type Item = usize

The type of the elements being iterated over.

type IntoIter = Range<usize>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Span

type Item = usize

The type of the elements being iterated over.

type IntoIter = Range<usize>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Span

fn cmp(&self, other: &Span) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Span> for Span

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

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

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

This method tests for !=.

impl PartialOrd<Span> for Span

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

impl Eq for Span

impl StructuralEq for Span

impl StructuralPartialEq for Span