Struct twilight_http::response::ResponseFuture
source · [−]pub struct ResponseFuture<T> { /* private fields */ }
Expand description
Future that will resolve to a Response
.
Canceling a response future pre-flight
Response futures can be canceled pre-flight via
ResponseFuture::set_pre_flight
. This allows you to cancel requests that
are no longer necessary once they have been cleared by the ratelimit queue,
which may be necessary in scenarios where requests are being spammed. Refer
to its documentation for more information.
Errors
Returns an ErrorType::Json
error type if serializing the response body
of the request failed.
Returns an ErrorType::Parsing
error type if the request failed and the
error in the response body could not be deserialized.
Returns an ErrorType::RequestCanceled
error type if the request was
canceled by the user.
Returns an ErrorType::RequestError
error type if creating the request
failed.
Returns an ErrorType::RequestTimedOut
error type if the request timed
out. The timeout value is configured via ClientBuilder::timeout
.
Returns an ErrorType::Response
error type if the request failed.
Returns an ErrorType::ServiceUnavailable
error type if the Discord API
is unavailable.
Implementations
Set a function to call after clearing the ratelimiter but prior to sending the request to determine if the request is still valid.
This function will be a no-op if the request has failed, has already passed the ratelimiter, or if there is no ratelimiter configured.
Returns whether the pre flight function was set.
Examples
Delete a message, but immediately before sending the request check if the request should still be sent:
use std::{collections::HashSet, env, sync::{Arc, Mutex}};
use twilight_http::{error::ErrorType, Client};
use twilight_model::id::{ChannelId, MessageId};
let channel_id = ChannelId::new(1).expect("non zero id");
let message_id = MessageId::new(2).expect("non zero id");
let channels_ignored = {
let mut map = HashSet::new();
map.insert(channel_id);
Arc::new(Mutex::new(map))
};
let client = Client::new(env::var("DISCORD_TOKEN")?);
let mut req = client.delete_message(channel_id, message_id).exec();
let channels_ignored_clone = channels_ignored.clone();
req.set_pre_flight(Box::new(move || {
// imagine you have some logic here to external state that checks
// whether the request should still be performed
let channels_ignored = channels_ignored_clone
.lock()
.expect("channels poisoned");
!channels_ignored.contains(&channel_id)
}));
// the pre-flight check will cancel the request
assert!(matches!(
req.await.unwrap_err().kind(),
ErrorType::RequestCanceled,
));
Trait Implementations
Auto Trait Implementations
impl<T> !RefUnwindSafe for ResponseFuture<T>
impl<T> Send for ResponseFuture<T> where
T: Send,
impl<T> !Sync for ResponseFuture<T>
impl<T> Unpin for ResponseFuture<T> where
T: Unpin,
impl<T> !UnwindSafe for ResponseFuture<T>
Blanket Implementations
Mutably borrows from an owned value. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Chain on a computation for when a future finished, passing the result of
the future to the provided closure f
. Read more
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the left-hand variant
of that Either
. Read more
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>,
Wrap this future in an Either
future, making it the right-hand variant
of that Either
. Read more
fn into_stream(self) -> IntoStream<Self>
fn into_stream(self) -> IntoStream<Self>
Convert this future into a single element stream. Read more
Flatten the execution of this future when the output of this future is itself another future. Read more
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self>
fn fuse(self) -> Fuse<Self>
Fuse a future such that poll
will never again be called once it has
completed. This method can be used to turn any Future
into a
FusedFuture
. Read more
Do something with the output of a future before passing it on. Read more
fn unit_error(self) -> UnitError<Self>
fn unit_error(self) -> UnitError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
fn never_error(self) -> NeverError<Self>
fn never_error(self) -> NeverError<Self>
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>. Read more
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
A convenience for calling Future::poll
on Unpin
future types.
fn now_or_never(self) -> Option<Self::Output>
fn now_or_never(self) -> Option<Self::Output>
Evaluates and consumes the future, returning the resulting output if
the future is ready after the first call to Future::poll
. Read more
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
into_future
)Creates a future from a value.
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture + ?Sized,
Maps this future’s success value to a different value. Read more
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T,
fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where
F: FnOnce(Self::Ok) -> T,
E: FnOnce(Self::Error) -> T,
Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more
Maps this future’s error value to a different value. Read more
Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more
Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
F: FnOnce(&Self::Ok),
Do something with the success value of a future before passing it on. Read more
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
F: FnOnce(&Self::Error),
Do something with the error value of a future before passing it on. Read more
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,
Flatten the execution of this future when the successful result of this future is another future. Read more
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,
Flatten the execution of this future when the successful result of this future is a stream. Read more
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,
fn into_future(self) -> IntoFuture<Self>
fn into_future(self) -> IntoFuture<Self>
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more