Struct timer_rs::Timer

source ·
pub struct Timer<F: 'static, S: 'static> { /* private fields */ }
Expand description

A timer, used to schedule execution of callbacks in a given future.

If the callback does not provide the new time period, the next execution will be scheduled for a distant future.

Implementations§

source§

impl<F, S> Timer<F, S>where F: Fn() -> Option<NaiveDateTime> + Send, S: Future + Send,

source

pub fn new(callback: F, shutdown: S) -> Self

Creates a Timer instance.

source

pub async fn schedule(&self, deadline: NaiveDateTime) -> Result<(), TimerError>

Schedule for execution after a delay.

source

pub fn scheduler(&self) -> Scheduler

Creates a handler to schedule new executions.

Trait Implementations§

source§

impl<F, S> IntoFuture for Timer<F, S>where F: Fn() -> Option<NaiveDateTime> + Send, S: Future + Send,

§

type Output = ()

The output that the future will produce on completion.
§

type IntoFuture = Pin<Box<dyn Future<Output = <Timer<F, S> as IntoFuture>::Output>, Global>>

Which kind of future are we turning this into?
source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<F, S> !RefUnwindSafe for Timer<F, S>

§

impl<F, S> Send for Timer<F, S>where F: Send, S: Send,

§

impl<F, S> Sync for Timer<F, S>where F: Sync, S: Sync,

§

impl<F, S> Unpin for Timer<F, S>

§

impl<F, S> !UnwindSafe for Timer<F, S>

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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<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 Twhere 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<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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