Struct egg_mode::cursor::CursorIter
[−]
[src]
#[must_use = "cursor iterators are lazy and do nothing unless consumed"] pub struct CursorIter<'a, T> where T: Cursor + FromJson { pub page_size: Option<i32>, pub previous_cursor: i64, pub next_cursor: i64, // some fields omitted }
Represents a paginated list of results, such as the users who follow a specific user or the lists owned by that user.
This struct is returned by various functions and is meant to be used as an iterator. This means that all the standard iterator adaptors can be used to work with the results:
for name in egg_mode::user::followers_of("rustlang", &con_token, &access_token) .map(|u| u.unwrap().response.screen_name).take(10) { println!("{}", name); }
You can even collect the results, letting you get one set of rate-limit information for the entire search setup:
use egg_mode::Response; use egg_mode::user::TwitterUser; use egg_mode::error::Error; let names: Result<Response<Vec<TwitterUser>>, Error> = egg_mode::user::followers_of("rustlang", &con_token, &access_token).take(10).collect();
CursorIter
has a couple adaptors of its own that you can use before consuming it.
with_page_size
will let you set how many users are pulled in with a single network call, and
start_at_page
lets you start your search at a specific page. Calling either of these after
starting iteration will clear any current results.
(A note about with_page_size
/page_size
: While the CursorIter
struct always has this method
and field available, not every cursored call supports changing page size. Check the individual
method documentation for notes on what page sizes are allowed.)
The type returned by the iterator is Result<Response<T::Item>, Error>
, so network errors,
rate-limit errors and other issues are passed directly through to next()
. This also means that
getting an error while iterating doesn't mean you're at the end of the list; you can wait for
the network connection to return or for the rate limit to refresh before trying again.
Manual paging
The iterator works by lazily loading a page of results at a time (with size set by
with_page_size
or by directly assigning page_size
for applicable calls) in the background
whenever you ask for the next result. This can be nice, but it also means that you can lose
track of when your loop will block for the next page of results. This is where the extra fields
and methods on UserSearch
come in. By using call()
, you can get the cursor struct directly
from Twitter. With that you can iterate over the results and page forward and backward as
needed:
let mut list = egg_mode::user::followers_of("rustlang", &con_token, &access_token).with_page_size(20); let resp = list.call().unwrap(); for user in resp.response.users { println!("{} (@{})", user.name, user.screen_name); } list.next_cursor = resp.response.next_cursor; let resp = list.call().unwrap(); for user in resp.response.users { println!("{} (@{})", user.name, user.screen_name); }
Fields
page_size: Option<i32>
The number of results returned in one network call.
Certain calls set their own minimums and maximums for what this value can be. Furthermore, some calls don't allow you to set the size of the pages at all. Refer to the individual methods' documentation for specifics.
previous_cursor: i64
Numeric reference to the previous page of results.
This value is intended to be automatically set and used as part of this struct's Iterator implementation. It is made available for those who wish to manually manage network calls and pagination.
next_cursor: i64
Numeric reference to the next page of results. A value of zero indicates that the current page of results is the last page of the cursor.
This value is intended to be automatically set and used as part of this struct's Iterator implementation. It is made available for those who wish to manually manage network calls and pagination.
Methods
impl<'a, T> CursorIter<'a, T> where T: Cursor + FromJson
[src]
fn with_page_size(self, page_size: i32) -> CursorIter<'a, T>
Sets the number of results returned in a single network call.
Certain calls set their own minimums and maximums for what this value can be. Furthermore, some calls don't allow you to set the size of the pages at all. Refer to the individual methods' documentation for specifics. If this method is called for a response that does not accept changing the page size, no change to the underlying struct will occur.
Calling this function will invalidate any current results, if any were previously loaded.
fn call(&self) -> WebResponse<T>
Loads the next page of results.
This is intended to be used as part of this struct's Iterator implementation. It is provided as a convenience for those who wish to manage network calls and pagination manually.
Trait Implementations
impl<'a, T> Iterator for CursorIter<'a, T> where T: Cursor + FromJson
[src]
type Item = WebResponse<T::Item>
The type of the elements being iterated over.
fn next(&mut self) -> Option<Self::Item>
Advances the iterator and returns the next value. Read more
fn size_hint(&self) -> (usize, Option<usize>)
1.0.0
Returns the bounds on the remaining length of the iterator. Read more
fn count(self) -> usize
1.0.0
Consumes the iterator, counting the number of iterations and returning it. Read more
fn last(self) -> Option<Self::Item>
1.0.0
Consumes the iterator, returning the last element. Read more
fn nth(&mut self, n: usize) -> Option<Self::Item>
1.0.0
Consumes the n
first elements of the iterator, then returns the next()
one. Read more
fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter> where U: IntoIterator<Item=Self::Item>
1.0.0
Takes two iterators and creates a new iterator over both in sequence. Read more
fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter> where U: IntoIterator
1.0.0
'Zips up' two iterators into a single iterator of pairs. Read more
fn map<B, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> B
1.0.0
Takes a closure and creates an iterator which calls that closure on each element. Read more
fn filter<P>(self, predicate: P) -> Filter<Self, P> where P: FnMut(&Self::Item) -> bool
1.0.0
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<B>
1.0.0
Creates an iterator that both filters and maps. Read more
fn enumerate(self) -> Enumerate<Self>
1.0.0
Creates an iterator which gives the current iteration count as well as the next value. Read more
fn peekable(self) -> Peekable<Self>
1.0.0
Creates an iterator which can use peek
to look at the next element of the iterator without consuming it. Read more
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where P: FnMut(&Self::Item) -> bool
1.0.0
Creates an iterator that [skip()
]s elements based on a predicate. Read more
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where P: FnMut(&Self::Item) -> bool
1.0.0
Creates an iterator that yields elements based on a predicate. Read more
fn skip(self, n: usize) -> Skip<Self>
1.0.0
Creates an iterator that skips the first n
elements. Read more
fn take(self, n: usize) -> Take<Self>
1.0.0
Creates an iterator that yields its first n
elements. Read more
fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where F: FnMut(&mut St, Self::Item) -> Option<B>
1.0.0
An iterator adaptor similar to [fold()
] that holds internal state and produces a new iterator. Read more
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where F: FnMut(Self::Item) -> U, U: IntoIterator
1.0.0
Creates an iterator that works like map, but flattens nested structure. Read more
fn fuse(self) -> Fuse<Self>
1.0.0
Creates an iterator which ends after the first None
. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item) -> ()
1.0.0
Do something with each element of an iterator, passing the value on. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Borrows an iterator, rather than consuming it. Read more
fn collect<B>(self) -> B where B: FromIterator<Self::Item>
1.0.0
Transforms an iterator into a collection. Read more
fn partition<B, F>(self, f: F) -> (B, B) where B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool
1.0.0
Consumes an iterator, creating two collections from it. Read more
fn fold<B, F>(self, init: B, f: F) -> B where F: FnMut(B, Self::Item) -> B
1.0.0
An iterator adaptor that applies a function, producing a single, final value. Read more
fn all<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool
1.0.0
Tests if every element of the iterator matches a predicate. Read more
fn any<F>(&mut self, f: F) -> bool where F: FnMut(Self::Item) -> bool
1.0.0
Tests if any element of the iterator matches a predicate. Read more
fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where P: FnMut(&Self::Item) -> bool
1.0.0
Searches for an element of an iterator that satisfies a predicate. Read more
fn position<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool
1.0.0
Searches for an element in an iterator, returning its index. Read more
fn rposition<P>(&mut self, predicate: P) -> Option<usize> where P: FnMut(Self::Item) -> bool, Self: ExactSizeIterator + DoubleEndedIterator
1.0.0
Searches for an element in an iterator from the right, returning its index. Read more
fn max(self) -> Option<Self::Item> where Self::Item: Ord
1.0.0
Returns the maximum element of an iterator. Read more
fn min(self) -> Option<Self::Item> where Self::Item: Ord
1.0.0
Returns the minimum element of an iterator. Read more
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B
1.6.0
Returns the element that gives the maximum value from the specified function. Read more
fn max_by<F>(self, compare: F) -> Option<Self::Item> where F: FnMut(&Self::Item, &Self::Item) -> Ordering
iter_max_by
)Returns the element that gives the maximum value with respect to the specified comparison function. Read more
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where B: Ord, F: FnMut(&Self::Item) -> B
1.6.0
Returns the element that gives the minimum value from the specified function. Read more
fn min_by<F>(self, compare: F) -> Option<Self::Item> where F: FnMut(&Self::Item, &Self::Item) -> Ordering
iter_min_by
)Returns the element that gives the minimum value with respect to the specified comparison function. Read more
fn rev(self) -> Rev<Self> where Self: DoubleEndedIterator
1.0.0
Reverses an iterator's direction. Read more
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Iterator<Item=(A, B)>
1.0.0
Converts an iterator of pairs into a pair of containers. Read more
fn cloned<'a, T>(self) -> Cloned<Self> where Self: Iterator<Item=&'a T>, T: 'a + Clone
1.0.0
Creates an iterator which clone()
s all of its elements. Read more
fn cycle(self) -> Cycle<Self> where Self: Clone
1.0.0
Repeats an iterator endlessly. Read more
fn sum<S>(self) -> S where S: Sum<Self::Item>
1.11.0
Sums the elements of an iterator. Read more
fn product<P>(self) -> P where P: Product<Self::Item>
1.11.0
Iterates over the entire iterator, multiplying all the elements Read more
fn cmp<I>(self, other: I) -> Ordering where I: IntoIterator<Item=Self::Item>, Self::Item: Ord
1.5.0
Lexicographically compares the elements of this Iterator
with those of another. Read more
fn partial_cmp<I>(self, other: I) -> Option<Ordering> where I: IntoIterator, Self::Item: PartialOrd<I::Item>
1.5.0
Lexicographically compares the elements of this Iterator
with those of another. Read more
fn eq<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>
1.5.0
Determines if the elements of this Iterator
are equal to those of another. Read more
fn ne<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialEq<I::Item>
1.5.0
Determines if the elements of this Iterator
are unequal to those of another. Read more
fn lt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>
1.5.0
Determines if the elements of this Iterator
are lexicographically less than those of another. Read more
fn le<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>
1.5.0
Determines if the elements of this Iterator
are lexicographically less or equal to those of another. Read more
fn gt<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>
1.5.0
Determines if the elements of this Iterator
are lexicographically greater than those of another. Read more
fn ge<I>(self, other: I) -> bool where I: IntoIterator, Self::Item: PartialOrd<I::Item>
1.5.0
Determines if the elements of this Iterator
are lexicographically greater than or equal to those of another. Read more