Struct Span

pub struct Span<T> { /* private fields */ }

This type is used to wrap any T with a SourceSpan, and is typically used when it is not convenient to add a SourceSpan to the type - most commonly because we don’t control the type.

Implementations

impl<T> Span<T>

pub fn new(span: impl Into<SourceSpan>, spanned: T) -> Span<T>

Creates a span for spanned with span.

pub fn at(source_id: SourceId, offset: usize, spanned: T) -> Span<T>

Creates a span for spanned representing a single location, offset.

pub fn unknown(spanned: T) -> Span<T>

Creates a Span from a value with an unknown/default location.

pub const fn span(&self) -> SourceSpan

Gets the associated SourceSpan for this spanned item.

pub const fn inner(&self) -> &T

Gets a reference to the spanned item.

pub fn map<U, F>(self, f: F) -> Span<U>

where F: FnMut(T) -> U,

Applies a transformation to the spanned value while retaining the same SourceSpan.

pub fn as_deref<U>(&self) -> Span<&U>

where T: Deref<Target = U>, U: ?Sized,

Like Option<T>::as_deref, this constructs a Span<U> wrapping the result of dereferencing the inner value of type T as a value of type U.

pub fn as_ref(&self) -> Span<&T>

Gets a new Span that borrows the inner value.

pub fn shift(&mut self, count: ByteOffset)

Shifts the span right by count units

pub fn extend(&mut self, count: ByteOffset)

Extends the end of the span by count units.

pub fn into_parts(self) -> (SourceSpan, T)

Consumes this span, returning the component parts, i.e. the SourceSpan and value of type T.

pub fn into_inner(self) -> T

Unwraps the spanned value of type T.

impl<T> Span<T>

where T: Serializable,

pub fn write_into_with_options<W>(&self, target: &mut W, debug: bool)

where W: ByteWriter,

impl<T> Span<T>

where T: Deserializable,

pub fn read_from_with_options<R>( source: &mut R, debug: bool, ) -> Result<Span<T>, DeserializationError>

where R: ByteReader,

Trait Implementations

impl<T, U> AsMut<T> for Span<U>

where U: AsMut<T>, T: ?Sized,

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, U> AsRef<T> for Span<U>

where U: AsRef<T>, T: ?Sized,

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, S> Borrow<T> for Span<S>

where T: Borrow<str>, S: Borrow<T>,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> Clone for Span<T>

where T: Clone,

fn clone(&self) -> Span<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Span<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Span<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Span<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Span<T>

fn deref_mut(&mut self) -> &mut <Span<T> as Deref>::Target

Mutably dereferences the value.

impl<T> Deserializable for Span<T>

where T: Deserializable,

fn read_from<R>(source: &mut R) -> Result<Span<T>, DeserializationError>

where R: ByteReader,

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<T> Display for Span<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> Hash for Span<T>

where T: Hash,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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<T> Ord for Span<T>

where T: Ord,

fn cmp(&self, other: &Span<T>) -> 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<T> PartialEq<T> for Span<T>

where T: PartialEq,

fn eq(&self, other: &T) -> 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<T> PartialEq for Span<T>

where T: PartialEq,

fn eq(&self, other: &Span<T>) -> 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<T> PartialOrd for Span<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &Span<T>) -> 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<T> PrettyPrint for Span<T>

where T: PrettyPrint,

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl<T> Serializable for Span<T>

where T: Serializable,

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

where W: ByteWriter,

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<T> Spanned for Span<T>

fn span(&self) -> SourceSpan

impl<T> Copy for Span<T>

where T: Copy,

impl<T> Eq for Span<T>

where T: Eq,