Struct egg_mode::Response
[−]
[src]
pub struct Response<T> { pub rate_limit: i32, pub rate_limit_remaining: i32, pub rate_limit_reset: i32, pub response: T, }
A helper struct to wrap response data with accompanying rate limit information.
This is returned by any function that calls a rate-limited method on Twitter, to allow for
inline checking of the rate-limit information without an extra call to
service::rate_limit_info
.
As this implements Deref
and DerefMut
, you can transparently use the contained response
's
methods as if they were methods on this struct.
Fields
rate_limit: i32
The rate limit ceiling for the given request.
rate_limit_remaining: i32
The number of requests left for the 15-minute window.
rate_limit_reset: i32
The UTC Unix timestamp at which the rate window resets.
response: T
The decoded response from the request.
Methods
impl<T> Response<T>
[src]
fn map<F, U>(src: Response<T>, fun: F) -> Response<U> where F: FnOnce(T) -> U
Convert a Response<T>
to a Response<U>
by running its contained response through the
given function. This preserves its rate-limit information.
Note that this is not a member function, so as to not conflict with potential methods on the
contained T
.
Trait Implementations
impl<T: Debug> Debug for Response<T>
[src]
impl<T> Deref for Response<T>
[src]
type Target = T
The resulting type after dereferencing
fn deref(&self) -> &Self::Target
The method called to dereference a value
impl<T> DerefMut for Response<T>
[src]
fn deref_mut(&mut self) -> &mut Self::Target
The method called to mutably dereference a value
impl<T> IntoIterator for Response<Vec<T>>
[src]
Iteration over a response that returned a collection, copying the rate limit information across all values.
type Item = Response<T>
The type of the elements being iterated over.
type IntoIter = ResponseIter<T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
impl<T> FromIterator<Response<T>> for Response<Vec<T>>
[src]
FromIterator
impl that allows collecting several responses into one, preserving the latest
rate limit information.
fn from_iter<I>(iter: I) -> Self where I: IntoIterator<Item=Response<T>>
Creates a value from an iterator. Read more