[−][src]Struct egg_mode::Response
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]
pub fn map<F, U>(src: Response<T>, fun: F) -> Response<U> where
F: FnOnce(T) -> U,
[src]
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
.
impl<T> Response<Vec<T>>
[src]
ⓘImportant traits for ResponseIterRef<'a, T>pub fn iter(&self) -> ResponseIterRef<T>
[src]
Returns an iterator that yields references into the returned collection, alongside rate-limit information for the whole method call.
ⓘImportant traits for ResponseIterMut<'a, T>pub fn iter_mut(&mut self) -> ResponseIterMut<T>
[src]
Returns an iterator that yields mutable references into the returned collection, alongside rate-limit information for the whole method call.
Trait Implementations
impl<'a, T> IntoIterator for &'a Response<Vec<T>> where
T: 'a,
[src]
T: 'a,
Iteration over a response that returned a collection, while leaving the response in place.
type Item = Response<&'a T>
The type of the elements being iterated over.
type IntoIter = ResponseIterRef<'a, T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
impl<'a, T> IntoIterator for &'a mut Response<Vec<T>> where
T: 'a,
[src]
T: 'a,
Mutable iteration over a response that returned a collection, while leaving the response in place.
type Item = Response<&'a mut T>
The type of the elements being iterated over.
type IntoIter = ResponseIterMut<'a, T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
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
[src]
impl<T> DerefMut for Response<T>
[src]
impl<T> Deref for Response<T>
[src]
impl<T: Debug> Debug for Response<T>
[src]
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>>,
[src]
I: IntoIterator<Item = Response<T>>,
impl<'de, T> Deserialize<'de> for Response<T> where
T: Deserialize<'de>,
T: Default,
[src]
T: Deserialize<'de>,
T: Default,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Erased for T
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> Same<T> for T
type Output = T
Should always be Self