[][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 if Syn is built with the "parsing" feature.

Methods

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

Creates a cursor referencing a static empty TokenStream.

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

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.

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

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

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

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

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

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.

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

Trait Implementations

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

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

Performs copy-assignment from source. Read more

impl<'a> Copy for Cursor<'a>
[src]

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

Auto Trait Implementations

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

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

Blanket Implementations

impl<T> From for T
[src]

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

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

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

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

The type returned in the event of a conversion error.

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

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

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

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

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

The type returned in the event of a conversion error.