Struct dialectic_compiler::Spanned

pub struct Spanned<T> {
    pub inner: T,
    pub span: Span,
}

A thing attached to some Span that tracks its origin in the macro invocation.

Fields

inner: T

The thing to which the Span is attached.

span: Span

The Span which is attache to the thing.

Implementations

impl Spanned<Syntax>

pub fn to_token_stream_with<F: ?Sized>(
    &self,
    add_optional: &mut F
) -> TokenStream where
    F: FnMut() -> bool, 

Convenience function for converting a Spanned<Syntax> into a TokenStream via Spanned::to_tokens_with.

pub fn to_tokens_with<F: ?Sized>(
    &self,
    add_optional: &mut F,
    tokens: &mut TokenStream
) where
    F: FnMut() -> bool, 

Convert a Spanned<Syntax> into tokens and append them to the provided token stream, with a predicate to determine whether or not optional syntax should be added or not.

The added optional syntax predicate is an FnMut closure so that we can randomly choose to add or not add optional trailing commas and similar during testing.

impl Spanned<Target>

pub fn to_token_stream_with_crate_name(
    &self,
    dialectic_crate: &Path
) -> TokenStream

Convert this Spanned<Target> into a TokenStream using a provided crate name when referencing types from dialectic.

pub fn to_tokens_with_crate_name(
    &self,
    dialectic_crate: &Path,
    tokens: &mut TokenStream
)

Convert this Spanned<Target> into tokens and append them to the provided TokenStream using a provided crate name when referencing types from dialectic.

Trait Implementations

impl Arbitrary for Spanned<Syntax>

Currently, we have a bit of a limitation on the arbitrary impl for syntax. The first part of this is that it’s annoying to generate valid labels for lifetimes, so for now we’re using a set of known valid lifetime names. The second is that generating valid Rust types is somewhat nontrivial and the syn crate does not have a way to ask it to implement Arbitrary for its Type AST node. So currently we just use the unit type () wherever we may need to place a type.

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Spanned<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> From<T> for Spanned<T>

fn from(inner: T) -> Self

Performs the conversion.

impl Parse for Spanned<Syntax>

fn parse(input: ParseStream<'_>) -> Result<Self>

impl ToTokens for Spanned<Syntax>

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

pub fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

pub fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.

impl ToTokens for Spanned<Target>

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

pub fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

pub fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.