smoltimeout

Struct Timed

Source 
pub struct Timed<Fut: Future> { /* private fields */ }
Expand description

A helper that polling both inner Future, and a Timer that will complete after a specified timeout or deadline.

§Example

see TimeoutExt::timeout and TimeoutExt::deadline.

Trait Implementations§

Source§

impl<Fut: Debug + Future> Debug for Timed<Fut>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Fut: Future> Future for Timed<Fut>

Source§

type Output = Option<<Fut as Future>::Output>

The type of value produced on completion.
Source§

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

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

impl<'__pin, Fut: Future> Unpin for Timed<Fut>
where PinnedFieldsOf<__Origin<'__pin, Fut>>: Unpin,

Auto Trait Implementations§

§

impl<Fut> Freeze for Timed<Fut>
where Fut: Freeze,

§

impl<Fut> RefUnwindSafe for Timed<Fut>
where Fut: RefUnwindSafe,

§

impl<Fut> Send for Timed<Fut>
where Fut: Send,

§

impl<Fut> Sync for Timed<Fut>
where Fut: Sync,

§

impl<Fut> UnwindSafe for Timed<Fut>
where Fut: 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§

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<Fut> TimedExt for Fut
where Fut: Future,

Source§

fn timeout(self, after: Duration) -> Timed<Self> ⓘ
where Self: Sized,

Given a Duration, creates and returns a new Timed that will poll both the Future, and a Timer that will complete after the provided duration. Read more
Source§

fn deadline(self, deadline: Instant) -> Timed<Self> ⓘ
where Self: Sized,

Given a Instant, creates and returns a new Timed that will poll both the Future and a Timer that will complete after the provided deadline. 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<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