TokenTree

facet_macros_parse

Enum TokenTree

pub enum TokenTree {
    Group(Group),
    Ident(Ident),
    Punct(Punct),
    Literal(Literal),
}

Expand description

A single token or a delimited sequence of token trees (e.g. [1, (), ..]).

Variants§

Group(Group)

A token stream surrounded by bracket delimiters.

Ident(Ident)

An identifier.

Punct(Punct)

A single punctuation character (+, ,, $, etc.).

Literal(Literal)

A literal character ('a'), string ("hello"), number (2.3), etc.

Implementations§

impl TokenTree

pub fn span(&self) -> Span

Returns the span of this tree, delegating to the span method of the contained token or a delimited stream.

pub fn set_span(&mut self, span: Span)

Configures the span for only this token.

Note that if this token is a Group then this method will not configure the span of each of the internal tokens, this will simply delegate to the set_span method of each variant.

Trait Implementations§

impl Clone for TokenTree

fn clone(&self) -> TokenTree

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for TokenTree

Prints token tree in a form convenient for debugging.

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

Formats the value using the given formatter. Read more

impl Display for TokenTree

Prints the token tree as a string that is supposed to be losslessly convertible back into the same token tree (modulo spans), except for possibly TokenTree::Groups with Delimiter::None delimiters and negative numeric literals.

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

Formats the value using the given formatter. Read more

impl Extend<TokenTree> for TokenStream

fn extend<I>(&mut self, streams: I)
where I: IntoIterator<Item = TokenTree>,

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

impl From<BraceGroup> for TokenTree

fn from(group: BraceGroup) -> TokenTree

Converts to this type from the input type.

impl<C> From<BraceGroupContaining<C>> for TokenTree
where C: ToTokens,

fn from(group: BraceGroupContaining<C>) -> TokenTree

Converts to this type from the input type.

impl From<BracketGroup> for TokenTree

fn from(group: BracketGroup) -> TokenTree

Converts to this type from the input type.

impl<C> From<BracketGroupContaining<C>> for TokenTree
where C: ToTokens,

fn from(group: BracketGroupContaining<C>) -> TokenTree

Converts to this type from the input type.

impl<T> From<Cached<T>> for TokenTree
where T: Into<TokenTree>,

Convert a Cached<T: Into<TokenTree>> object into a TokenTree.

fn from(cached: Cached<T>) -> TokenTree

Converts to this type from the input type.

impl From<Group> for TokenTree

fn from(g: Group) -> TokenTree

Converts to this type from the input type.

impl<C> From<GroupContaining<C>> for TokenTree
where C: ToTokens,

fn from(group: GroupContaining<C>) -> TokenTree

Converts to this type from the input type.

impl From<Ident> for TokenTree

fn from(g: Ident) -> TokenTree

Converts to this type from the input type.

impl From<Literal> for TokenTree

fn from(g: Literal) -> TokenTree

Converts to this type from the input type.

impl From<LiteralCharacter> for TokenTree

fn from(lit: LiteralCharacter) -> TokenTree

Converts to this type from the input type.

impl From<LiteralInteger> for TokenTree

fn from(lit: LiteralInteger) -> TokenTree

Converts to this type from the input type.

impl From<LiteralString> for TokenTree

fn from(lit: LiteralString) -> TokenTree

Converts to this type from the input type.

impl From<NoneGroup> for TokenTree

fn from(group: NoneGroup) -> TokenTree

Converts to this type from the input type.

impl<C> From<NoneGroupContaining<C>> for TokenTree
where C: ToTokens,

fn from(group: NoneGroupContaining<C>) -> TokenTree

Converts to this type from the input type.

impl From<ParenthesisGroup> for TokenTree

fn from(group: ParenthesisGroup) -> TokenTree

Converts to this type from the input type.

impl<C> From<ParenthesisGroupContaining<C>> for TokenTree
where C: ToTokens,

fn from(group: ParenthesisGroupContaining<C>) -> TokenTree

Converts to this type from the input type.

impl From<Punct> for TokenTree

fn from(g: Punct) -> TokenTree

Converts to this type from the input type.

impl<const C: char> From<PunctAlone<C>> for TokenTree

Convert a PunctAlone object into a TokenTree.

fn from(_: PunctAlone<C>) -> TokenTree

Converts to this type from the input type.

impl<const C: char> From<PunctAny<C>> for TokenTree

Convert a PunctAny object into a TokenTree.

fn from(_: PunctAny<C>) -> TokenTree

Converts to this type from the input type.

impl<const C: char> From<PunctJoint<C>> for TokenTree

Convert a PunctJoint object into a TokenTree.

fn from(_: PunctJoint<C>) -> TokenTree

Converts to this type from the input type.

impl From<TokenTree> for TokenStream

fn from(token: TokenTree) -> TokenStream

Converts to this type from the input type.

impl FromIterator<TokenTree> for TokenStream

Collects a number of token trees into a single stream.

fn from_iter<I>(streams: I) -> TokenStream
where I: IntoIterator<Item = TokenTree>,

Creates a value from an iterator. Read more

impl Parser for TokenTree

fn parser(tokens: &mut TokenIter) -> Result<TokenTree, Error>

The actual parsing function that must be implemented. This mutates the tokens iterator directly. It should not be called from user code except for implementing parsers itself and then only when the rules below are followed. Read more

impl ToTokens for TokenTree

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

Write &self to the given TokenStream. Read more

fn to_token_iter(&self) -> TokenIter ⓘ

Convert &self into a TokenIter object.

fn into_token_iter(self) -> TokenIter ⓘ
where Self: Sized,

Convert self into a TokenIter object.

fn to_token_stream(&self) -> TokenStream

Convert &self into a TokenStream object.

fn into_token_stream(self) -> TokenStream
where Self: Sized,

Convert self into a TokenStream object.

fn tokens_to_string(&self) -> String

Convert &self into a String object. This is mostly used in the test suite to compare the outputs. When the input is a &str then this parses it and returns a normalized String.

Auto Trait Implementations§

impl Freeze for TokenTree

impl RefUnwindSafe for TokenTree

impl !Send for TokenTree

impl !Sync for TokenTree

impl Unpin for TokenTree

impl UnwindSafe for TokenTree

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynamicTokens for T
where T: Any + ToTokens + Debug,

fn as_any(&self) -> &(dyn Any + 'static)

Upcasts &DynamicTokens to &dyn Any. This allows us to stay backward compatible with older rust. Rust 1.86 implements upcast coercion.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Parse for T
where T: Parser,

fn parse(tokens: &mut TokenIter) -> Result<Self, Error>

This is the user facing API to parse grammatical entities. Calls a parser() within a transaction. Commits changes on success and returns the parsed value. Read more

fn parse_all(tokens: &mut TokenIter) -> Result<Self, Error>

Exhaustive parsing within a transaction. This is a convenience method that implies a EndOfStream at the end. Thus it will error if parsing is not exhaustive. Read more

fn parse_with<T>( tokens: &mut TokenIter, f: impl FnOnce(Self, &mut TokenIter) -> Result<T, Error>, ) -> Result<T, Error>

Parse a value in a transaction, pass it to a FnOnce(Self, &mut TokenIter) -> Result<T> closure which creates a new result or returns an Error. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.