proc_macro::Punct - Rust
Description: API documentation for the Rust `Punct` struct in crate `proc_macro`.
Keywords: rust, rustlang, rust-lang, Punct

# Struct proc_macro::Punct 1.29.0[−][src]

    pub struct Punct { /* fields omitted */ }

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`

[src]

####

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

[src]

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`

[src]

Returns the value of this punctuation character as `char`.

####

`pub fn spacing(&self) -> Spacing`

[src]

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`

[src]

Returns the span for this punctuation character.

####

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

[src]

Configure the span for this punctuation character.

## Trait Implementations

###

`impl From<Punct> for TokenTree`

[src]

####

`fn from(g: Punct) -> TokenTree`

[src]

Performs the conversion.

###

`impl Clone for Punct`

[src]

####

`fn clone(&self) -> Punct`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl !Send for Punct`

[src]

###

`impl !Sync for Punct`

[src]

###

`impl Display for Punct`

[src]

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

####

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

[src]

Formats the value using the given formatter. Read more

###

`impl Debug for Punct`

[src]

####

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

[src]

Formats the value using the given formatter. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)