Struct codespan::Span

pub struct Span { /* fields omitted */ }

Implementations

impl Span

pub fn new(start: impl Into<ByteIndex>, end: impl Into<ByteIndex>) -> Span

Create a new span from a starting and ending span.

pub const fn initial() -> Span

Gives an empty span at the start of a source.

pub fn from_str(s: &str) -> Span

Measure the span of a string.

use codespan::{ByteIndex, Span};

let span = Span::from_str("hello");

assert_eq!(span, Span::new(0, 5));

pub fn merge(self, other: Span) -> Span

Combine two spans by taking the start of the earlier span and the end of the later span.

Note: this will work even if the two spans are disjoint. If this doesn't make sense in your application, you should handle it yourself. In that case, you can use Span::disjoint as a convenience function.

use codespan::Span;

let span1 = Span::new(0, 4);
let span2 = Span::new(10, 16);

assert_eq!(Span::merge(span1, span2), Span::new(0, 16));

pub fn disjoint(self, other: Span) -> bool

A helper function to tell whether two spans do not overlap.

use codespan::Span;
let span1 = Span::new(0, 4);
let span2 = Span::new(10, 16);
assert!(span1.disjoint(span2));

pub fn start(self) -> ByteIndex

Get the starting byte index.

use codespan::{ByteIndex, Span};

let span = Span::new(0, 4);

assert_eq!(span.start(), ByteIndex::from(0));

pub fn end(self) -> ByteIndex

Get the ending byte index.

use codespan::{ByteIndex, Span};

let span = Span::new(0, 4);

assert_eq!(span.end(), ByteIndex::from(4));

Trait Implementations

impl Clone for Span

pub fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Span

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

pub fn default() -> Span

Returns the "default value" for a type.

impl Display for Span

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

Formats the value using the given formatter.

impl Eq for Span

impl<I> From<Range<I>> for Span where
    I: Into<ByteIndex>, 

pub fn from(range: Range<I>) -> Span

Performs the conversion.

impl From<Span> for Range<usize>

pub fn from(span: Span) -> Range<usize>

Performs the conversion.

impl From<Span> for Range<RawIndex>

pub fn from(span: Span) -> Range<RawIndex>

Performs the conversion.

impl Hash for Span

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Span

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Span> for Span

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

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

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

This method tests for !=.

impl PartialOrd<Span> for Span

pub fn partial_cmp(&self, other: &Span) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Span

impl StructuralPartialEq for Span