Struct wasm_timer::Timer [−][src]
A “timer heap” used to power separately owned instances of Delay and
Interval.
This timer is implemented as a priority queued-based heap. Each Timer
contains a few primary methods which which to drive it:
next_wakeindicates how long the ambient system needs to sleep until it invokes further processing on aTimeradvance_tois what actually fires timers on theTimer, and should be called essentially every iteration of the event loop, or when the time specified bynext_wakehas elapsed.- The
Futureimplementation forTimeris used to process incoming timer updates and requests. This is used to schedule new timeouts, update existing ones, or delete existing timeouts. TheFutureimplementation will never resolve, but it’ll schedule notifications of when to wake up and process more messages.
Note that if you’re using this crate you probably don’t need to use a
Timer as there is a global one already available for you run on a helper
thread. If this isn’t desirable, though, then the
TimerHandle::set_fallback method can be used instead!
Implementations
impl Timer[src]
pub fn new() -> Timerⓘ[src]
Creates a new timer heap ready to create new timers.
pub fn handle(&self) -> TimerHandle[src]
Returns a handle to this timer heap, used to create new timeouts.
pub fn next_event(&self) -> Option<Instant>[src]
Returns the time at which this timer next needs to be invoked with
advance_to.
Event loops or threads typically want to sleep until the specified instant.
pub fn advance(&mut self)[src]
Proces any timers which are supposed to fire at or before the current instant.
This method is equivalent to self.advance_to(Instant::now()).
pub fn advance_to(&mut self, now: Instant)[src]
Proces any timers which are supposed to fire before now specified.
This method should be called on Timer periodically to advance the
internal state and process any pending timers which need to fire.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Timer
impl Send for Timer
impl Sync for Timer
impl Unpin for Timer
impl !UnwindSafe for Timer
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
T: Future + ?Sized,
pub fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U, [src]
F: FnOnce(Self::Output) -> U,
pub fn map_into<U>(self) -> MapInto<Self, U> where
Self::Output: Into<U>, [src]
Self::Output: Into<U>,
pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, [src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
pub fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>, [src]
B: Future<Output = Self::Output>,
pub fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>, [src]
A: Future<Output = Self::Output>,
pub fn into_stream(self) -> IntoStream<Self>[src]
pub fn flatten(self) -> Flatten<Self> where
Self::Output: Future, [src]
Self::Output: Future,
pub fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream, [src]
Self::Output: Stream,
pub fn fuse(self) -> Fuse<Self>[src]
pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output), [src]
F: FnOnce(&Self::Output),
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
Self: UnwindSafe,
pub fn shared(self) -> Shared<Self> where
Self::Output: Clone, [src]
Self::Output: Clone,
pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)[src]
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a, [src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a, [src]
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
pub fn unit_error(self) -> UnitError<Self>[src]
pub fn never_error(self) -> NeverError<Self>[src]
pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin, [src]
Self: Unpin,
pub fn now_or_never(self) -> Option<Self::Output>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future, [src]
F: Future,
type Output = <F as Future>::Output
into_future)The output that the future will produce on completion.
type Future = F
into_future)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future[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.
pub 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>,