Skip to main content

PeriodicTask

aster_forge_tasks

Struct PeriodicTask 

Source 
pub struct PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> {
    pub name: Name,
    pub task_name: &'static str,
    pub interval_fn: IntervalFn,
    pub jitter_cap: Option<Duration>,
    pub shutdown_token: CancellationToken,
    pub state: State,
    pub hooks: RecordedTaskHooks<TaskFn, PanicFn, RecordFn>,
}
Expand description

Configuration for one periodic runtime task worker.

Fields§

§name: Name

Product task identifier.

§task_name: &'static str

Stable task name used in tracing spans.

§interval_fn: IntervalFn

Reads the latest product-configured interval.

§jitter_cap: Option<Duration>

Optional upper bound for positive jitter.

§shutdown_token: CancellationToken

Shared shutdown token.

§state: State

Product runtime state passed to callbacks.

§hooks: RecordedTaskHooks<TaskFn, PanicFn, RecordFn>

Product callbacks for execution, panic conversion, and recording.

Auto Trait Implementations§

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> Freeze for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: Freeze, IntervalFn: Freeze, State: Freeze, TaskFn: Freeze, PanicFn: Freeze, RecordFn: Freeze,

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> RefUnwindSafe for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: RefUnwindSafe, IntervalFn: RefUnwindSafe, State: RefUnwindSafe, TaskFn: RefUnwindSafe, PanicFn: RefUnwindSafe, RecordFn: RefUnwindSafe,

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> Send for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: Send, IntervalFn: Send, State: Send, TaskFn: Send, PanicFn: Send, RecordFn: Send,

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> Sync for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: Sync, IntervalFn: Sync, State: Sync, TaskFn: Sync, PanicFn: Sync, RecordFn: Sync,

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> Unpin for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: Unpin, IntervalFn: Unpin, State: Unpin, TaskFn: Unpin, PanicFn: Unpin, RecordFn: Unpin,

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> UnsafeUnpin for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: UnsafeUnpin, IntervalFn: UnsafeUnpin, State: UnsafeUnpin, TaskFn: UnsafeUnpin, PanicFn: UnsafeUnpin, RecordFn: UnsafeUnpin,

§

impl<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn> UnwindSafe for PeriodicTask<Name, State, IntervalFn, TaskFn, PanicFn, RecordFn>
where Name: UnwindSafe, IntervalFn: UnwindSafe, State: UnwindSafe, TaskFn: UnwindSafe, PanicFn: UnwindSafe, RecordFn: 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more