Struct calypso_base::span::Spanned

pub struct Spanned<T>where
    T: Debug,{
    span: Span,
    value: T,
}

An object that’s associated with a Span

Example

let spanned = Spanned::new(Span::new(0, 1), 42);
// Since we're asserting more than one thing, we can't do `spanned.value_owned()`, as that would anger the borrow checker.
// Instead, since integers are `Copy`, we can just dereference the `&{integer}` we get back from `spanned.value()`.
assert_eq!(*spanned.value(), 42);
assert_eq!(spanned.span(), Span::new(0, 1));

Fields

span: Span

value: T

Implementations

impl<T> Spanned<T>where
    T: Debug,

pub fn new(span: Span, value: T) -> Self

Associate a span with a value.

pub fn value(&self) -> &T

Get a reference to the value.

pub fn value_owned(self) -> T

Get the owned value.

pub fn span(&self) -> Span

Get the value’s Span

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

Convert a &'a Spanned<T> into a Spanned<&'a T>.

pub fn map<U: Debug>(self, f: impl FnOnce(T) -> U) -> Spanned<U>

Map the value of a Spanned<T>.

Trait Implementations

impl<T> Clone for Spanned<T>where
    T: Debug + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Spanned<T>where
    T: Debug + Debug,

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

Formats the value using the given formatter.

impl<T: Debug> From<(T, Range<u32>)> for Spanned<T>

fn from((val, range): (T, Range<u32>)) -> Self

Converts to this type from the input type.

impl<T: Debug> From<(u32, T, u32)> for Spanned<T>

fn from((lo, val, hi): (u32, T, u32)) -> Self

Converts to this type from the input type.

impl<T> Hash for Spanned<T>where
    T: Debug + Hash,

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<T> PartialEq<Spanned<T>> for Spanned<T>where
    T: Debug + PartialEq,

fn eq(&self, other: &Spanned<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialEq + Debug> PartialEq<T> for Spanned<T>

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for Spanned<T>where
    T: Debug + Copy,

impl<T> Eq for Spanned<T>where
    T: Debug + Eq,

impl<T> StructuralEq for Spanned<T>where
    T: Debug,

impl<T> StructuralPartialEq for Spanned<T>where
    T: Debug,