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

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

    pub struct Punct(_);

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

Multi-character operators like `+=` are represented as two instances of `Punct` with different forms of `Spacing` returned.

## Implementations

### `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 multi-character 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 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 Debug for Punct`[src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

### `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 From<Punct> for TokenTree`[src]

#### `fn from(g: Punct) -> TokenTree`[src]

Performs the conversion.

### `impl !Send for Punct`[src]

### `impl !Sync for Punct`[src]

### `impl ToString for Punct` 1.15.0[src]

#### `fn to_string(&self) -> String`[src]

Converts the given value to a `String`. Read more

## Auto Trait Implementations

### `impl RefUnwindSafe for Punct`

### `impl Unpin for Punct`

### `impl UnwindSafe for Punct`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `default fn to_string(&self) -> String`[src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.