Struct Punct

pub struct Punct {
    pub(crate) ch: char,
    pub(crate) spacing: Spacing,
    pub(crate) span: Span,
}

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.

Fields

ch: char

spacing: Spacing

span: Span

Implementations

impl Punct

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

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

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) -> Self

Converts to this type from the input type.