ferroid

Struct GeneratorFuture

Source 
pub struct GeneratorFuture<'a, G, ID, T, S>
where
    G: SnowflakeGenerator<ID, T>,
    ID: Snowflake,
    T: TimeSource<ID::Ty>,
    S: SleepProvider,
{ /* private fields */ }
Expand description

A future that polls a SnowflakeGenerator until it is ready to produce an ID.

This future handles Pending responses by sleeping for a recommended amount of time before polling the generator again.

Implementations§

Source§

impl<'a, G, ID, T, S> GeneratorFuture<'a, G, ID, T, S>
where G: SnowflakeGenerator<ID, T>, ID: Snowflake, T: TimeSource<ID::Ty>, S: SleepProvider,

Source

pub fn new(generator: &'a G) -> Self

Constructs a new GeneratorFuture from a given generator.

This does not immediately begin polling the generator; instead, it will attempt to produce an ID when .poll() is called.

Trait Implementations§

Source§

impl<'a, G, ID, T, S> Future for GeneratorFuture<'a, G, ID, T, S>
where G: SnowflakeGenerator<ID, T>, ID: Snowflake, T: TimeSource<ID::Ty>, S: SleepProvider,

Source§

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

Polls the generator for a new ID.

If the generator is not ready, this will register the task waker and sleep for the time recommended by the generator before polling again.

Source§

type Output = Result<ID, Error>

The type of value produced on completion.
Source§

impl<'__pin, 'a, G, ID, T, S> Unpin for GeneratorFuture<'a, G, ID, T, S>
where PinnedFieldsOf<__Origin<'__pin, 'a, G, ID, T, S>>: Unpin, G: SnowflakeGenerator<ID, T>, ID: Snowflake, T: TimeSource<ID::Ty>, S: SleepProvider,

Auto Trait Implementations§

§

impl<'a, G, ID, T, S> Freeze for GeneratorFuture<'a, G, ID, T, S>
where <S as SleepProvider>::Sleep: Freeze,

§

impl<'a, G, ID, T, S> RefUnwindSafe for GeneratorFuture<'a, G, ID, T, S>
where G: RefUnwindSafe, <S as SleepProvider>::Sleep: RefUnwindSafe, ID: RefUnwindSafe, T: RefUnwindSafe,

§

impl<'a, G, ID, T, S> Send for GeneratorFuture<'a, G, ID, T, S>
where G: Sync, <S as SleepProvider>::Sleep: Send, ID: Send, T: Send,

§

impl<'a, G, ID, T, S> Sync for GeneratorFuture<'a, G, ID, T, S>
where G: Sync, <S as SleepProvider>::Sleep: Sync, ID: Sync, T: Sync,

§

impl<'a, G, ID, T, S> UnwindSafe for GeneratorFuture<'a, G, ID, T, S>
where G: RefUnwindSafe, <S as SleepProvider>::Sleep: UnwindSafe, ID: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<F> FutureExt for F
where F: Future + ?Sized,

Source§

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

A convenience for calling Future::poll() on !Unpin types.
Source§

fn or<F>(self, other: F) -> Or<Self, F>
where Self: Sized, F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more
Source§

fn race<F>(self, other: F) -> Race<Self, F>
where Self: Sized, F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more
Source§

fn catch_unwind(self) -> CatchUnwind<Self>
where Self: Sized + UnwindSafe,

Catches panics while polling the future. Read more
Source§

fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a>>
where Self: Sized + Send + 'a,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more
Source§

fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>>
where Self: Sized + 'a,

Boxes the future and changes its type to dyn Future + 'a. 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<U> for T
where U: From<T>,

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 F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

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<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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