Struct debris_common::Span

pub struct Span {
    start: usize,
    len: usize,
}

A span which uniquely specifies a span of characters in their corresponding file All spans are dependent on the InputFiles which contains the file that spans can refer to.

Fields

start: usize

len: usize

Implementations

impl Span

pub const EMPTY: Span = _

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

Creates a new Span from the starting character and its length

pub fn at_start(&self) -> Span

Returns a span with the same start and a length of one

pub fn start(&self) -> usize

Returns the start of this span

pub fn end(&self) -> usize

Returns the end of this span

pub fn len(&self) -> usize

Returns the length of this span

pub fn is_empty(&self) -> bool

Returns, whether this span is empty

Thanks, clippy.

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

Constructs a new span which ranges from the start of this span to the end of the other span

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

pub fn char_bounds(&self, source: &str) -> (usize, usize)

Since ranges are used to index into a str on a byte level, a span starting at index 10 is not necessarily the character at index 10. This methods iterates over the source chars until it finds the character at the byte positions marked by this span. This methods panics if the span is out of bounds.

Returns:

The returned tuple has the shape (start_character_index, end_character_index)

Trait Implementations

impl Add<Span> for usize

type Output = Span

The resulting type after applying the + operator.

fn add(self, rhs: Span) -> Self::Output

Performs the + operation.

impl Add<usize> for Span

type Output = Span

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

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 From<Range<usize>> for Span

fn from(value: Range<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq 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: &Rhs) -> bool

This method 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 StructuralEq for Span

impl StructuralPartialEq for Span