Struct Punct

pub struct Punct(/* private fields */);

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

Multi-character 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 can be potentially combined into a multi-character operator with the following token (Joint), or whether the operator has definitely ended (Alone).

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 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 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.

impl From<Punct> for TokenTree

fn from(g: Punct) -> TokenTree

Converts to this type from the input type.

impl PartialEq<Punct> for char

fn eq(&self, rhs: &Punct) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<char> for Punct

fn eq(&self, rhs: &char) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToTokens for Punct

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

🔬This is a nightly-only experimental API. (proc_macro_totokens #130977)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

🔬This is a nightly-only experimental API. (proc_macro_totokens #130977)

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

🔬This is a nightly-only experimental API. (proc_macro_totokens #130977)

Convert self directly into a TokenStream object.

impl !Send for Punct

impl !Sync for Punct