Struct Span

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

A span corresponding to a range in the source file being parsed.

Fields

start: ByteIndex

The start of the span in bytes.

end: ByteIndex

The end of the span in bytes.

Implementations

impl Span

pub fn new<S, E>(start: S, end: E) -> Self

where S: TryInto<ByteIndex>, S::Error: Debug, E: TryInto<ByteIndex>, E::Error: Debug,

Construct a new span.

Examples

use rune::ast::Span;

let span = Span::new(42, 50);
assert!(span < Span::new(100, 101));

pub fn point<P>(pos: P) -> Self

where P: TryInto<ByteIndex>, P::Error: Debug,

Get a span corresponding to a single point where both start and end are the same byte offset.

Examples

use rune::ast::Span;

assert_eq!(Span::point(42), Span::new(42, 42));

pub const fn empty() -> Self

Constant function to build an empty span.

Examples

use rune::ast::Span;

assert_eq!(Span::empty(), Span::new(0, 0));

pub fn head(self) -> Self

Get the head of the span.

pub fn tail(self) -> Self

Get the tail of the span.

pub fn join(self, other: Self) -> Self

Join two spans creating the larger of the two spans.

Examples

use rune::ast::Span;

let a = Span::new(10, 12);
let b = Span::new(20, 22);

assert_eq!(a.join(b), Span::new(10, 22));

pub fn narrow(self, amount: impl Into<ByteIndex>) -> Self

Narrow the span with the given amount.

If the narrowing causes the span to become empty, the resulting span will reflect the starting point of the narrowed span.

Examples

use rune::ast::Span;

assert_eq!(Span::new(10, 12).narrow(4), Span::new(10, 10));
assert_eq!(Span::new(5, 15).narrow(2), Span::new(7, 13));

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

Get the span as a range of usize.

Panics

Panics if the span contains ranges which cannot be faithfully represented in an usize.

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<'de> Deserialize<'de> for Span

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Span

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

Formats the value using the given formatter.

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

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for Span

fn span(&self) -> Span

Get the span of the type.

impl TryClone for Span

fn try_clone(&self) -> Result<Self>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span