Struct Span 

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

A half-open byte range into a UTF-8 source string.

start is inclusive and end is exclusive. Offsets are bytes, rather than character or display columns, so a span can be used directly to slice the original query after checking that both endpoints are UTF-8 boundaries.

Fields

start: usize

Inclusive byte offset.

end: usize

Exclusive byte offset.

Implementations

impl Span

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

Creates a span from an inclusive start and exclusive end offset.

Panics

Panics if start > end.

pub const fn empty(offset: usize) -> Self

Creates an empty span at offset.

pub const fn start(self) -> usize

Returns the inclusive start byte offset.

pub const fn end(self) -> usize

Returns the exclusive end byte offset.

pub const fn len(self) -> usize

Returns the number of source bytes covered by this span.

pub const fn is_empty(self) -> bool

Returns true when this span covers no source bytes.

pub const fn contains(self, offset: usize) -> bool

Returns true when offset is inside this half-open span.

pub const fn contains_span(self, other: Self) -> bool

Returns true when other is entirely contained in this span.

pub const fn cover(self, other: Self) -> Self

Returns the smallest span covering both inputs.

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

Returns this span as a standard half-open range.

pub fn text(self, source: &str) -> Option<&str>

Returns the source text covered by this span.

None is returned if the span is outside source or either endpoint falls in the middle of a UTF-8 code point.

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

impl Debug for Span

fn fmt(&self, formatter: &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 Display for Span

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

Formats the value using the given formatter.

impl Eq for Span

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

fn cmp(&self, other: &Span) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Span

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Span