# [−] [src] Struct syn::buffer::Cursor

    pub struct Cursor<'a> { /* fields omitted */ }

A cheaply copyable cursor into a `TokenBuffer`.

This cursor holds a shared reference into the immutable data which is used internally to represent a `TokenStream`, and can be efficiently manipulated and copied around.

An empty `Cursor` can be created directly, or one may create a `TokenBuffer` object and get a cursor to its first token with `begin()`.

Two cursors are equal if they have the same location in the same input stream, and have the same scope.

This type is available only if Syn is built with the `"parsing"` feature.

## Implementations

### `impl<'a> Cursor<'a>` [src]

#### `pub fn empty() -> Self` [src]

Creates a cursor referencing a static empty TokenStream.

#### `pub fn eof(self) -> bool` [src]

Checks whether the cursor is currently pointing at the end of its valid scope.

#### `pub fn group(self, delim: Delimiter) -> Option<(Cursor<'a>, Span, Cursor<'a>)>` [src]

If the cursor is pointing at a `Group` with the given delimiter, returns a cursor into that group and one pointing to the next `TokenTree`.

#### `pub fn ident(self) -> Option<(Ident, Cursor<'a>)>` [src]

If the cursor is pointing at a `Ident`, returns it along with a cursor pointing at the next `TokenTree`.

#### `pub fn punct(self) -> Option<(Punct, Cursor<'a>)>` [src]

If the cursor is pointing at an `Punct`, returns it along with a cursor pointing at the next `TokenTree`.

#### `pub fn literal(self) -> Option<(Literal, Cursor<'a>)>` [src]

If the cursor is pointing at a `Literal`, return it along with a cursor pointing at the next `TokenTree`.

#### `pub fn lifetime(self) -> Option<(Lifetime, Cursor<'a>)>` [src]

If the cursor is pointing at a `Lifetime`, returns it along with a cursor pointing at the next `TokenTree`.

#### `pub fn token_stream(self) -> TokenStream` [src]

Copies all remaining tokens visible from this cursor into a `TokenStream`.

#### `pub fn token_tree(self) -> Option<(TokenTree, Cursor<'a>)>` [src]

If the cursor is pointing at a `TokenTree`, returns it along with a cursor pointing at the next `TokenTree`.

Returns `None` if the cursor has reached the end of its stream.

This method does not treat `None`-delimited groups as transparent, and will return a `Group(None, ..)` if the cursor is looking at one.

#### `pub fn span(self) -> Span` [src]

Returns the `Span` of the current token, or `Span::call_site()` if this cursor points to eof.

## Trait Implementations

### `impl<'a> Clone for Cursor<'a>` [src]

#### `fn clone(&self) -> Self` [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<'a> Copy for Cursor<'a>` [src]

### `impl<'a> Eq for Cursor<'a>` [src]

### `impl<'a> PartialEq<Cursor<'a>> for Cursor<'a>` [src]

#### `fn eq(&self, other: &Self) -> bool` [src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `#[must_use]fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

## Auto Trait Implementations

### `impl<'a> RefUnwindSafe for Cursor<'a>`

### `impl<'a> !Send for Cursor<'a>`

### `impl<'a> !Sync for Cursor<'a>`

### `impl<'a> Unpin for Cursor<'a>`

### `impl<'a> UnwindSafe for Cursor<'a>`

## Blanket Implementations

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

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

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

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

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

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

Performs the conversion.

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

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

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

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

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

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

recently added

Uses borrowed data to replace owned data, usually by cloning. 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.

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

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

Performs the conversion.