Struct syn::buffer::Cursor

source ·
pub struct Cursor<'a> { /* private fields */ }
Expand description

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.

Implementations

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

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.