Struct Spanned 

pub struct Spanned<T> {
    pub span: Span,
    pub value: T,
    pub comments: Vec<Spanned<Comment>>,
}

A syntax node with source span information attached.

This is the universal wrapper for AST nodes, analogous to:

• A.Located in elm/compiler
• Node in stil4m/elm-syntax
• Spanned in many Rust parser crates

Each node carries optional leading comments — comments that appeared immediately before this node in source. This enables round-tripping of comments inside expressions (let-in, case-of, etc.).

Fields

span: Span

value: T

comments: Vec<Spanned<Comment>>

Leading comments that appeared immediately before this node in source.

Implementations

impl<T> Spanned<T>

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

Create a new spanned node with no leading comments.

pub fn dummy(value: T) -> Self

Create a spanned node with a dummy span (for synthesized/constructed nodes).

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

Map the inner value, preserving the span and comments.

pub fn with_comments(self, comments: Vec<Spanned<Comment>>) -> Self

Attach leading comments to this node.

pub fn inner(&self) -> &T

Get a reference to the inner value.

pub fn inner_mut(&mut self) -> &mut T

Get a mutable reference to the inner value.

pub fn into_inner(self) -> T

Unwrap the spanned node, discarding the span.

Trait Implementations

impl<T: Clone> Clone for Spanned<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Display> Display for Spanned<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Spanned<T>

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

fn eq(&self, other: &Spanned<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: Eq> Eq for Spanned<T>

impl<T> StructuralPartialEq for Spanned<T>