# Struct proc_macro2::Punct

source · [−]

    pub struct Punct { /* private fields */ }

Expand description

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.

## Implementations

source

### impl Punct

source

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

source

#### pub fn as_char(&self) -> char

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

source

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

source

#### pub fn span(&self) -> Span

Returns the span for this punctuation character.

source

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

Configure the span for this punctuation character.

## Trait Implementations

source

### impl Clone for Punct

source

#### fn clone(&self) -> Punct

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl Debug for Punct

source

#### fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

### impl Display for Punct

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

source

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

Formats the value using the given formatter. Read more

source

### impl From<Punct> for TokenTree

source

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

Converts to this type from the input type.

## Auto Trait Implementations

### impl RefUnwindSafe for Punct

### impl !Send for Punct

### impl !Sync for Punct

### impl Unpin for Punct

### impl UnwindSafe for Punct

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

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

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

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

source

#### fn clone_into(&self, target: &mut T)

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

source

### impl<T> ToString for T where
T: Display + ?Sized,

source

#### default fn to_string(&self) -> String

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

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.