Struct proc_macro::Punct

pub struct Punct { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (proc_macro #38356)

An Punct is an single punctuation character like +, - or #.

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

Methods

impl Punct

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

🔬 This is a nightly-only experimental API. (proc_macro #38356)

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

🔬 This is a nightly-only experimental API. (proc_macro #38356)

Returns the value of this punctuation character as char.

pub fn spacing(&self) -> Spacing

🔬 This is a nightly-only experimental API. (proc_macro #38356)

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

🔬 This is a nightly-only experimental API. (proc_macro #38356)

Returns the span for this punctuation character.

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

🔬 This is a nightly-only experimental API. (proc_macro #38356)

Configure the span for this punctuation character.

Trait Implementations

impl From<Punct> for TokenTree

fn from(g: Punct) -> TokenTree

Performs the conversion.

impl Clone for Punct

fn clone(&self) -> Punct

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Punct

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

Formats the value using the given formatter.

impl !Send for Punct

impl !Sync for Punct

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

Formats the value using the given formatter.