Struct runestick::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(start: impl IntoByteIndex, end: impl IntoByteIndex) -> Self

Construct a new span.

pub const fn const_new(start: u32, end: u32) -> Self

Constant function to build a span.

pub const fn empty() -> Self

Constant function to build an empty span.

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

Get the span as an usize range.

pub fn adjust(self, diff: ByteIndex) -> Self

Adjust the span with the given positive offset.

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

Check if current span completely overlaps with another.

pub fn len(self) -> ByteIndex

Get the length of the span.

pub fn is_empty(self) -> bool

Check if the span is empty.

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

Join this span with another span.

pub fn point(pos: impl IntoByteIndex) -> Self

Get the point span.

pub fn narrow(self, amount: impl IntoByteIndex) -> Self

Narrow the span with the given amount.

pub fn trim_start(self, amount: impl IntoByteIndex) -> Self

Trim the start of the span by the given amount.

pub fn trim_end(self, amount: impl IntoByteIndex) -> Self

Trim the end of the span by the given amount.

pub fn start(self) -> Self

Get the start as a point span.

pub fn end(self) -> Self

Get the end as a point span.

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

fn from(span: Span) -> Self

Performs the conversion.

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

impl Eq for Span

impl StructuralEq for Span

impl StructuralPartialEq for Span