Trait egg_mode::cursor::Cursor

source · 
pub trait Cursor {
    type Item;

    fn previous_cursor_id(&self) -> i64;
    fn next_cursor_id(&self) -> i64;
    fn into_inner(self) -> Vec<Self::Item> ⓘ;
}
Expand description

Trait to generalize over paginated views of API results.

Types that implement Cursor are used as intermediate steps in CursorIter’s Stream implementation, to properly load the data from Twitter. Most of the time you don’t need to deal with Cursor structs directly, but you can get them via CursorIter’s manual paging functionality.

Required Associated Types§

source

type Item

What type is being returned by the API call?

Required Methods§

source

fn previous_cursor_id(&self) -> i64

Returns a numeric reference to the previous page of results.

source

fn next_cursor_id(&self) -> i64

Returns a numeric reference to the next page of results.

source

fn into_inner(self) -> Vec<Self::Item> ⓘ

Unwraps the cursor, returning the collection of results from inside.

Implementors§