Skip to main content

FormatArgs

Struct FormatArgs 

Source
pub struct FormatArgs { /* private fields */ }
Expand description

A format specification: A format string followed by arguments to be formatted in accordance with that string.

This type can only be built inside of a macro context since it performs constant evaluation.

Both the format string and the arguments are held as the tokens they were written as rather than as a syntax tree, so nothing here recurses over what a macro was handed - see MacroContext::exprs.

Implementations§

Source§

impl FormatArgs

Source

pub fn parse( cx: &mut MacroContext<'_, '_, '_>, stream: &TokenStream, ) -> Result<Self>

Parse format arguments out of the whole input of a macro.

§Examples
use rune::macros::{self, quote, FormatArgs};

macros::test(|cx| {
    let stream = quote!("Hello {}", 42).into_token_stream(cx)?;
    let args = FormatArgs::parse(cx, &stream)?;
    let expanded = args.expand(cx)?.into_token_stream(cx)?;
    assert!(expanded.kinds().count() > 0);
    Ok(())
})?;
Source

pub fn from_exprs<I>( cx: &mut MacroContext<'_, '_, '_>, exprs: I, ) -> Result<Self>
where I: IntoIterator<Item = TokenStream>,

Build format arguments out of expressions which have already been split out of the input of a macro with MacroContext::exprs.

This is what a macro whose format specification is preceded by arguments of its own uses, assert! being one.

Source

pub fn expand(&self, cx: &mut MacroContext<'_, '_, '_>) -> Result<Quote<'_>>

Expand the format specification.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more