Struct Punct 

pub struct Punct { /* private fields */ }

A Punct is a single punctuation character like +, - or #.

Multicharacter operators like += are represented as two instances of Punct with different forms of Spacing returned.

Implementations

impl Punct

pub fn new(ch: char, spacing: Spacing) -> Punct

Creates a new Punct from the given character and spacing.

The ch argument must be a valid punctuation character permitted by the language, otherwise the function will panic.

The returned Punct will have the default span of Span::call_site() which can be further configured with the set_span method below.

pub fn as_char(&self) -> char

Returns the value of this punctuation character as char.

pub fn spacing(&self) -> Spacing

Returns the spacing of this punctuation character, indicating whether it’s immediately followed by another Punct in the token stream, so they can potentially be combined into a multicharacter operator (Joint), or it’s followed by some other token or whitespace (Alone) so the operator has certainly ended.

pub fn span(&self) -> Span

Returns the span for this punctuation character.

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

Configure the span for this punctuation character.

Trait Implementations

impl Clone for Punct

fn clone(&self) -> Punct

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Punct

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

Formats the value using the given formatter.

impl Display for Punct

Prints the punctuation character as a string that should be losslessly convertible back into the same character.

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

Formats the value using the given formatter.

impl From<Cached<Punct>> for Punct

Convert CachedPunct into a Punct`.

fn from(cached: Cached<Punct>) -> Punct

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 Parser for Punct

fn parser(tokens: &mut TokenIter) -> Result<Punct, 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.

impl ToTokens for Punct

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

Write &self to the given TokenStream.

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.