Struct SourceSpan

pub struct SourceSpan { /* private fields */ }

This represents a span of bytes in a Miden Assembly source file.

It is compact, using only 8 bytes to represent the full span. This does, however, come at the tradeoff of only supporting source files of up to 2^32 bytes.

This type is produced by the lexer and carried through parsing. It can be converted into a line/column range as well, if needed.

This representation is more convenient to produce, and allows showing source spans in error messages, whereas line/column information is useful at a glance in debug output, it is harder to produce nice errors with it compared to this representation.

Implementations

impl SourceSpan

pub const UNKNOWN: Self

A sentinel SourceSpan that indicates the span is unknown/invalid

pub fn new<B>(source_id: SourceId, range: Range<B>) -> Self

where B: Into<ByteIndex>,

Creates a new SourceSpan from the given range.

pub fn at(source_id: SourceId, offset: impl Into<ByteIndex>) -> Self

Creates a new SourceSpan for a specific offset.

pub fn try_from_range( source_id: SourceId, range: Range<usize>, ) -> Result<Self, InvalidByteIndexRange>

Try to create a new SourceSpan from the given range with usize bounds.

pub const fn is_unknown(&self) -> bool

Returns true if this SourceSpan represents the unknown span

pub fn source_id(&self) -> SourceId

Get the SourceId associated with this source span

pub fn start(&self) -> ByteIndex

Gets the offset in bytes corresponding to the start of this span (inclusive).

pub fn end(&self) -> ByteIndex

Gets the offset in bytes corresponding to the end of this span (exclusive).

pub fn len(&self) -> usize

Gets the length of this span in bytes.

pub fn is_empty(&self) -> bool

Returns true if this span is empty.

pub fn into_range(self) -> Range<u32>

Converts this span into a Range<u32>.

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

Converts this span into a Range<usize>.

Trait Implementations

impl Clone for SourceSpan

fn clone(&self) -> SourceSpan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceSpan

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

Formats the value using the given formatter.

impl Default for SourceSpan

fn default() -> SourceSpan

Returns the “default value” for a type.

impl Deserializable for SourceSpan

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl From<SourceSpan> for Range<u32>

fn from(span: SourceSpan) -> Self

Converts to this type from the input type.

impl From<SourceSpan> for Range<usize>

fn from(span: SourceSpan) -> Self

Converts to this type from the input type.

impl Hash for SourceSpan

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 Index<SourceSpan> for [u8]

type Output = [u8]

The returned type after indexing.

fn index(&self, index: SourceSpan) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for SourceSpan

fn cmp(&self, other: &SourceSpan) -> 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 SourceSpan

fn eq(&self, other: &SourceSpan) -> 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 SourceSpan

fn partial_cmp(&self, other: &SourceSpan) -> 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 RangeBounds<ByteIndex> for SourceSpan

fn start_bound(&self) -> Bound<&ByteIndex>

Start index bound.

fn end_bound(&self) -> Bound<&ByteIndex>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl Serializable for SourceSpan

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Spanned for SourceSpan

fn span(&self) -> SourceSpan

impl Copy for SourceSpan

impl Eq for SourceSpan

impl StructuralPartialEq for SourceSpan