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

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

    pub struct Group { /* fields omitted */ }

A delimited token stream.

A `Group` internally contains a `TokenStream` which is surrounded by `Delimiter`s.

## Methods

###

`impl Group`

[src]

####

`pub fn new(delimiter: Delimiter, stream: TokenStream) -> Group`

[src]

Creates a new `Group` with the given delimiter and token stream.

This constructor will set the span for this group to `Span::call_site()`. To change the span you can use the `set_span` method below.

####

`pub fn delimiter(&self) -> Delimiter`

[src]

Returns the delimiter of this `Group`

####

`pub fn stream(&self) -> TokenStream`

[src]

Returns the `TokenStream` of tokens that are delimited in this `Group`.

Note that the returned token stream does not include the delimiter returned above.

####

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

[src]

Returns the span for the delimiters of this token stream, spanning the entire `Group`.

    pub fn span(&self) -> Span {
               ^^^^^^^

####

`pub fn span_open(&self) -> Span`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_span` #38356)

Returns the span pointing to the opening delimiter of this group.

    pub fn span_open(&self) -> Span {
                    ^

####

`pub fn span_close(&self) -> Span`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_span` #38356)

Returns the span pointing to the closing delimiter of this group.

    pub fn span_close(&self) -> Span {
                           ^

####

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

[src]

Configures the span for this `Group`'s delimiters, but not its internal tokens.

This method will not set the span of all the internal tokens spanned by this group, but rather it will only set the span of the delimiter tokens at the level of the `Group`.

## Trait Implementations

###

`impl !Sync for Group`

[src]

###

`impl !Send for Group`

[src]

###

`impl From<Group> for TokenTree`

[src]

####

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

[src]

Performs the conversion.

###

`impl Clone for Group`

[src]

####

`fn clone(&self) -> Group`

[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 Group`

[src]

####

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

[src]

Formats the value using the given formatter. Read more

###

`impl Display for Group`

[src]

Prints the group as a string that should be losslessly convertible back into the same group (modulo spans), except for possibly `TokenTree::Group`s with `Delimiter::None` delimiters.

####

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

[src]

Formats the value using the given formatter. Read more

## Blanket Implementations

###

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

[src]

#### `type Owned = T`

####

`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]

####

`fn to_string(&self) -> String`

[src]

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

###

`impl<T> From for T`

[src]

####

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

[src]

Performs the conversion.

###

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

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

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

[src]

Immutably borrows from an owned value. Read more

###

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

[src]

####

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

[src]

Mutably borrows from an owned value. Read more

###

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

[src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

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

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

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

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

###

`impl<E> SpecializationError for E`

[src]

####

`fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where T: ?Sized,`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private` #27812)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. `S` is the encoder/decoder state type, `T` is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more

###

`impl<T> Erased for T`

[src]

###

`impl<T> Send for T where T: ?Sized,`

[src]

###

`impl<T> Sync for T where T: ?Sized,`

[src]

###

`impl<T> Erased for T`

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