Punct in proc_macro - Rust
Description: A `Punct` is a single punctuation character such as `+`, `-` or `#`.

## Punct

# Struct Punct

1.29.0 · Source

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

Expand description

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§

Source§

### impl Punct

1.29.0 · Source

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

1.29.0 · Source

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

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

1.29.0 · Source

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

1.29.0 · Source

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

Returns the span for this punctuation character.

1.29.0 · Source

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

Configure the span for this punctuation character.

## Trait Implementations§

1.29.0 · Source§

### impl Clone for Punct

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
1.29.0 · Source§

### impl Debug for Punct

Source§

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

Formats the value using the given formatter. Read more
1.29.0 · 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
1.92.0 · Source§

### impl Extend<Punct> for TokenStream

Source§

#### fn extend<T: IntoIterator<Item = Punct>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
Source§

#### fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (`extend_one` #72631)
Extends a collection with exactly one element.
Source§

#### fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (`extend_one` #72631)
Reserves capacity in a collection for the given number of additional elements. Read more
1.29.0 · Source§

### impl From<Punct> for TokenTree

Source§

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

Converts to this type from the input type.
1.52.0 · Source§

### impl PartialEq<Punct> for char

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl PartialEq<char> for Punct

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl ToTokens for Punct

Source§

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

🔬This is a nightly-only experimental API. (`proc_macro_totokens` #130977)
Write `self` to the given `TokenStream`. Read more
Source§

#### fn to_token_stream(&self) -> TokenStream

🔬This is a nightly-only experimental API. (`proc_macro_totokens` #130977)
Convert `self` directly into a `TokenStream` object. Read more
Source§

#### 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. Read more
1.29.0 · Source§

### impl !Send for Punct

1.29.0 · Source§

### impl !Sync for Punct

## Auto Trait Implementations§

§

### impl Freeze for Punct

§

### impl RefUnwindSafe 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,

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit` #126799)
Performs copy-assignment from `self` to `dest`. Read more
Source§

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

Source§

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

Returns the argument unchanged.

Source§

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

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,

Source§

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

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

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.