Struct Span 

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

A span of source code, represented as a byte range.

Spans use half-open intervals: [start, end). An empty span has start == end.

Fields

start: u32

Start byte offset (inclusive)

end: u32

End byte offset (exclusive)

Implementations

impl Span

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

Create a new span from start and end offsets.

pub const fn at(pos: u32) -> Self

Create an empty span at the given position.

pub const fn from_len(start: u32, len: u32) -> Self

Create a span from start position and length.

pub const fn dummy() -> Self

Create a dummy/invalid span (used for synthetic nodes).

pub const fn is_dummy(&self) -> bool

Check if this is a dummy/invalid span.

pub const fn len(&self) -> u32

Get the length of this span in bytes.

pub const fn is_empty(&self) -> bool

Check if this span is empty.

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

Check if this span contains a byte offset.

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

Check if this span contains another span.

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

Check if this span overlaps with another span.

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

Merge two spans to create a span covering both.

pub fn intersect(&self, other: Self) -> Option<Self>

Get the intersection of two spans, if they overlap.

pub const fn shrink_start(&self, amount: u32) -> Self

Shrink this span by removing bytes from the start.

pub const fn shrink_end(&self, amount: u32) -> Self

Shrink this span by removing bytes from the end.

pub const fn first_byte(&self) -> Self

Create a span for just the first byte.

pub const fn last_byte(&self) -> Self

Create a span for just the last byte.

pub fn slice<'a>(&self, text: &'a str) -> &'a str

Extract the slice of text covered by this span.

pub fn slice_safe<'a>(&self, text: &'a str) -> &'a str

Extract the slice of text covered by this span, with safety checks.

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 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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<(u32, u32)> for Span

fn from((start, end): (u32, u32)) -> Self

Converts to this type from the input type.

impl From<Span> for (u32, u32)

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 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 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 source span of this element.

fn start(&self) -> u32

Get the start byte offset.

fn end(&self) -> u32

Get the end byte offset.

fn len(&self) -> u32

Get the length in bytes.

fn is_empty(&self) -> bool

Check if the span is empty.

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span