Trait timer_kit::Delay

pub trait Delay {
    type Value;
    type Instant: Instant;

    fn delay(duration: Duration) -> Self;
    fn delay_until(deadline: Self::Instant) -> Self;
    fn deadline(&self) -> Option<Self::Instant>;
    fn poll_elapsed(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>
    ) -> Poll<Self::Value>;
    fn reset(self: Pin<&mut Self>, deadline: Self::Instant);
}

A trait that defines a delay, which is the fundamental building block of this crate.

Implementations

Implementations for the following types are provided with the corresponding features enabled:

Type	Feature	Target Arch
tokio::time::Sleep	"tokio"	non-wasm32
[smol::Timer]	"smol"	non-wasm32
futures_timer::Delay	"futures-timer"	non-wasm32
[wasm_timer::Delay]	"wasm-timer"	wasm32
[fluvio_wasm_timer::Delay]	"fluvio-wasm-timer"	wasm32

User could also provide their own implementations for other types to use the timer functionalities provided by this crate.

Required Associated Types

type Value

The type of value returned by the delay upon completion of poll_elapsed.

type Instant: Instant

The type of instant used by the delay.

Required Methods

fn delay(duration: Duration) -> Self

Creates a new delay with a specified duration.

fn delay_until(deadline: Self::Instant) -> Self

Creates a new delay with a specified deadline.

fn deadline(&self) -> Option<Self::Instant>

Some implementation do not expose the deadline, so this is an optional.

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

Polls the delay for completion.

fn reset(self: Pin<&mut Self>, deadline: Self::Instant)

Resets the delay to a new deadline.

Implementations on Foreign Types

impl Delay for Sleep

type Value = ()

type Instant = Instant

fn delay(duration: Duration) -> Self

fn delay_until(deadline: Instant) -> Self

fn deadline(&self) -> Option<Instant>

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

fn reset(self: Pin<&mut Self>, deadline: Instant)

impl Delay for Timer

type Value = Instant

type Instant = Instant

fn delay(duration: Duration) -> Self

fn delay_until(deadline: Self::Instant) -> Self

fn deadline(&self) -> Option<Self::Instant>

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

fn reset(self: Pin<&mut Self>, deadline: Self::Instant)

impl Delay for Delay

type Value = ()

type Instant = Instant

fn delay(duration: Duration) -> Self

fn delay_until(deadline: Self::Instant) -> Self

fn deadline(&self) -> Option<Self::Instant>

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

fn reset(self: Pin<&mut Self>, deadline: Self::Instant)

Implementors