Struct twilight_http_ratelimiting::ticket::TicketReceiver

source ·

pub struct TicketReceiver(_);

Expand description

Channel receiver to wait for availability of a ratelimit ticket.

This is used by the ratelimiter consumer (such as an API client) to wait for an available ratelimit ticket.

Once one is available, a TicketSender will be produced which can be used to send the associated HTTP response’s ratelimit headers.

Trait Implementations§

source §

impl Debug for TicketReceiver

source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source §

impl Future for TicketReceiver

§

type Output = Result<TicketSender, RecvError>

The type of value produced on completion.

source §

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

§

impl !UnwindSafe for TicketReceiver

Blanket Implementations§

source §

impl<T> Any for Twhere
T: 'static + ?Sized,

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source §

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source §

impl<T> FutureExt for Twhere
T: Future + ?Sized,

source §

fn map<U, F>(self, f: F) -> Map<Self, F>where
F: FnOnce(Self::Output) -> U,
Self: Sized,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

source §

fn map_into(self) -> MapInto<Self, U>where
Self::Output: Into,
Self: Sized,

Map this future’s output to a different type, returning a new future of the resulting type. Read more

source §

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
 F: FnOnce(Self::Output) -> Fut,
 Fut: Future,
 Self: Sized,

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

source §

fn left_future(self) -> Either<Self, B>where
B: Future<Output = Self::Output>,
Self: Sized,

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

source §

fn right_future<A>(self) -> Either<A, Self>where
A: Future<Output = Self::Output>,
Self: Sized,

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

source §

fn into_stream(self) -> IntoStream<Self>where
Self: Sized,

Convert this future into a single element stream. Read more

source §

fn flatten(self) -> Flatten<Self>where
Self::Output: Future,
Self: Sized,

Flatten the execution of this future when the output of this future is itself another future. Read more

source §

fn flatten_stream(self) -> FlattenStream<Self>where
Self::Output: Stream,
Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream. Read more

source §

fn fuse(self) -> Fuse<Self>where
Self: Sized,

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

source §

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnOnce(&Self::Output),
Self: Sized,

Do something with the output of a future before passing it on. Read more

source §

fn unit_error(self) -> UnitError<Self>where
Self: Sized,

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>.

source §

fn never_error(self) -> NeverError<Self>where
Self: Sized,

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>.

source §

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>where
Self: Unpin,

A convenience for calling Future::poll on Unpin future types.

source §

fn now_or_never(self) -> Option<Self::Output>where
Self: Sized,

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

source §

impl<T> Instrument for T

source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source §

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source §

impl<F> IntoFuture for Fwhere
F: Future,

§

type Output = <F as Future>::Output

The output that the future will produce on completion.

§

type IntoFuture = F

Which kind of future are we turning this into?

source §

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

source §

impl<T, U> TryFrom for Twhere
U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

§

impl<F, T, E> TryFuture for Fwhere
F: Future<Output = Result<T, E>> + ?Sized,

§

type Ok = T

The type of successful values yielded by this future

§

type Error = E

The type of failures yielded by this future

§

fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

source §

impl<Fut> TryFutureExt for Futwhere
Fut: TryFuture + ?Sized,

source §

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where
F: FnOnce(Self::Ok) -> T,
Self: Sized,

Maps this future’s success value to a different value. Read more

source §

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,
 Self: Sized,

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

source §

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,

Maps this future’s error value to a different value. Read more

source §

fn err_into<E>(self) -> ErrInto<Self, E>where
Self: Sized,
Self::Error: Into<E>,

Maps this future’s Error to a new error type using the Into trait. Read more

source §

fn ok_into(self) -> OkInto<Self, U>where
Self: Sized,
Self::Ok: Into,

Maps this future’s Ok to a new type using the Into trait.

source §

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>where
 F: FnOnce(Self::Ok) -> Fut,
 Fut: TryFuture<Error = Self::Error>,
 Self: Sized,

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

source §

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>where
 F: FnOnce(Self::Error) -> Fut,
 Fut: TryFuture<Ok = Self::Ok>,
 Self: Sized,

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

source §

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>where
F: FnOnce(&Self::Ok),
Self: Sized,

Do something with the success value of a future before passing it on. Read more

source §

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnOnce(&Self::Error),
Self: Sized,

Do something with the error value of a future before passing it on. Read more

source §

fn try_flatten(self) -> TryFlatten<Self, Self::Ok>where
Self::Ok: TryFuture<Error = Self::Error>,
Self: Sized,

Flatten the execution of this future when the successful result of this future is another future. Read more

source §

fn try_flatten_stream(self) -> TryFlattenStream<Self>where
Self::Ok: TryStream<Error = Self::Error>,
Self: Sized,

Flatten the execution of this future when the successful result of this future is a stream. Read more

source §

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>where
Self: Sized,
F: FnOnce(Self::Error) -> Self::Ok,

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

source §

fn into_future(self) -> IntoFuture<Self>where
Self: Sized,

Wraps a [TryFuture] into a type that implements Future. Read more

source §

fn try_poll_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>>where
 Self: Unpin,

A convenience method for calling [TryFuture::try_poll] on Unpin future types.

source §

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

§

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source §

impl<T> WithSubscriber for T

source §

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source §

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct twilight_http_ratelimiting::ticket::TicketReceiver

Trait Implementations§

impl Debug for TicketReceiver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Future for TicketReceiver

type Output = Result<TicketSender, RecvError>

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Auto Trait Implementations§

impl !RefUnwindSafe for TicketReceiver

impl Send for TicketReceiver

impl Sync for TicketReceiver

impl Unpin for TicketReceiver

impl !UnwindSafe for TicketReceiver

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for Twhere T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F>where F: FnOnce(Self::Output) -> U, Self: Sized,

fn map_into<U>(self) -> MapInto<Self, U>where Self::Output: Into<U>, Self: Sized,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where F: FnOnce(Self::Output) -> Fut, Fut: Future, Self: Sized,

fn left_future<B>(self) -> Either<Self, B>where B: Future<Output = Self::Output>, Self: Sized,

fn right_future<A>(self) -> Either<A, Self>where A: Future<Output = Self::Output>, Self: Sized,

fn into_stream(self) -> IntoStream<Self>where Self: Sized,

fn flatten(self) -> Flatten<Self>where Self::Output: Future, Self: Sized,

fn flatten_stream(self) -> FlattenStream<Self>where Self::Output: Stream, Self: Sized,

fn fuse(self) -> Fuse<Self>where Self: Sized,

fn inspect<F>(self, f: F) -> Inspect<Self, F>where F: FnOnce(&Self::Output), Self: Sized,

fn unit_error(self) -> UnitError<Self>where Self: Sized,

fn never_error(self) -> NeverError<Self>where Self: Sized,

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>where Self: Unpin,

fn now_or_never(self) -> Option<Self::Output>where Self: Sized,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for Fwhere F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<F, T, E> TryFuture for Fwhere F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>) -> Poll<<F as Future>::Output>

impl<Fut> TryFutureExt for Futwhere Fut: TryFuture + ?Sized,

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where F: FnOnce(Self::Ok) -> T, Self: Sized,

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, Self: Sized,

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>where F: FnOnce(Self::Error) -> E, Self: Sized,

fn err_into<E>(self) -> ErrInto<Self, E>where Self: Sized, Self::Error: Into<E>,

fn ok_into<U>(self) -> OkInto<Self, U>where Self: Sized, Self::Ok: Into<U>,

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>where F: FnOnce(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>, Self: Sized,

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>where F: FnOnce(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>, Self: Sized,

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>where F: FnOnce(&Self::Ok), Self: Sized,

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where F: FnOnce(&Self::Error), Self: Sized,

fn try_flatten(self) -> TryFlatten<Self, Self::Ok>where Self::Ok: TryFuture<Error = Self::Error>, Self: Sized,

fn try_flatten_stream(self) -> TryFlattenStream<Self>where Self::Ok: TryStream<Error = Self::Error>, Self: Sized,

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>where Self: Sized, F: FnOnce(Self::Error) -> Self::Ok,

fn into_future(self) -> IntoFuture<Self>where Self: Sized,

fn try_poll_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<Self::Ok, Self::Error>>where Self: Unpin,

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> FutureExt for Twhere
T: Future + ?Sized,

fn map<U, F>(self, f: F) -> Map<Self, F>where
F: FnOnce(Self::Output) -> U,
Self: Sized,

fn map_into<U>(self) -> MapInto<Self, U>where
Self::Output: Into<U>,
Self: Sized,

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
Self: Sized,

fn left_future<B>(self) -> Either<Self, B>where
B: Future<Output = Self::Output>,
Self: Sized,

fn right_future<A>(self) -> Either<A, Self>where
A: Future<Output = Self::Output>,
Self: Sized,

fn into_stream(self) -> IntoStream<Self>where
Self: Sized,

fn flatten(self) -> Flatten<Self>where
Self::Output: Future,
Self: Sized,

fn flatten_stream(self) -> FlattenStream<Self>where
Self::Output: Stream,
Self: Sized,

fn fuse(self) -> Fuse<Self>where
Self: Sized,

fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnOnce(&Self::Output),
Self: Sized,

fn unit_error(self) -> UnitError<Self>where
Self: Sized,

fn never_error(self) -> NeverError<Self>where
Self: Sized,

fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output>where
Self: Unpin,

fn now_or_never(self) -> Option<Self::Output>where
Self: Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<F> IntoFuture for Fwhere
F: Future,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<F, T, E> TryFuture for Fwhere
F: Future<Output = Result<T, E>> + ?Sized,

fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

impl<Fut> TryFutureExt for Futwhere
Fut: TryFuture + ?Sized,

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>where
F: FnOnce(Self::Ok) -> T,
Self: Sized,

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,
Self: Sized,

fn map_err<E, F>(self, f: F) -> MapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,

fn err_into<E>(self) -> ErrInto<Self, E>where
Self: Sized,
Self::Error: Into<E>,

fn ok_into<U>(self) -> OkInto<Self, U>where
Self: Sized,
Self::Ok: Into<U>,

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F>where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
Self: Sized,

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F>where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
Self: Sized,

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F>where
F: FnOnce(&Self::Ok),
Self: Sized,

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F>where
F: FnOnce(&Self::Error),
Self: Sized,

fn try_flatten(self) -> TryFlatten<Self, Self::Ok>where
Self::Ok: TryFuture<Error = Self::Error>,
Self: Sized,

fn try_flatten_stream(self) -> TryFlattenStream<Self>where
Self::Ok: TryStream<Error = Self::Error>,
Self: Sized,

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>where
Self: Sized,
F: FnOnce(Self::Error) -> Self::Ok,

fn into_future(self) -> IntoFuture<Self>where
Self: Sized,

fn try_poll_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<Self::Ok, Self::Error>>where
Self: Unpin,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,