Skip to main content

ScheduleModule

Struct ScheduleModule 

Source
pub struct ScheduleModule { /* private fields */ }
Expand description

schedule.* over the session’s values.

Implementations§

Source§

impl ScheduleModule

Source

pub fn new( store: Box<dyn KeyedDocuments>, session_id: &str, clock: Arc<dyn TickClock>, listener: Option<Listener>, ) -> Self

Source

pub fn with_github(self, github: GitHub) -> Self

Select the argv runner (a scripted executable in isolated tests).

Source

pub fn now(&self) -> i64

Source

pub fn all(&self) -> Result<Vec<Schedule>, String>

This session’s schedules, in the order they were created (values copied from another session are not).

Source

pub fn entries(&self) -> Result<Vec<Value>, String>

The active schedules as the server keeps them.

Source

pub fn put(&self, schedule: &Schedule) -> Result<(), String>

Write schedule as it is (a schedule the server keeps itself, such as the durable instance’s dream).

Source

pub fn cancel(&self, name_or_id: &str) -> Result<Schedule, String>

Cancel by id, else active name, else latest name (including a final run already queued).

Source

pub fn fire(&self, id: &str, due: i64) -> Result<Option<Fired>, String>

Run schedule id for its slot due: records the run (and the next slot after now) and returns the prompt message. None: nothing to run (not active, not due yet, or due is not its next slot: a duplicate fire).

Source

pub fn fire_with( &self, id: &str, due: i64, deliver: &mut dyn FnMut(&Value) -> Result<(), String>, ) -> Result<Option<Fired>, String>

ScheduleModule::fire that counts the run only once deliver took its prompt message (started or queued a run): a delivery that fails writes nothing (the slot stays due, an at schedule stays active) and its error is returned.

Source§

impl ScheduleModule

Source

pub fn skip(&self, id: &str, due: i64) -> Result<Option<Schedule>, String>

Pass over the due slot due of the repeating schedule id without running it (no run counted, last_fired kept): its next slot after now. None when it is not due at due, or does not repeat.

Trait Implementations§

Source§

impl ApiModule for ScheduleModule

Source§

fn prefixes(&self) -> &[&str]

Source§

fn handle(&self, request: &Request<'_>) -> Result<Value, String>

Source§

fn start(&self, _host: &dyn TaskHost) -> Result<(), String>

Called once before the first request is served.

Auto Trait Implementations§

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<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<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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