Skip to main content

GoalDriver

Struct GoalDriver 

Source
pub struct GoalDriver { /* private fields */ }

Implementations§

Source§

impl GoalDriver

Source

pub fn new( store: Arc<dyn DocumentStore>, jobs: Arc<dyn GoalJobs>, now: Clock, ) -> Self

Source

pub fn recover(&self) -> Result<Option<Value>, String>

Loads the goal and reconciles it with the task journal (the worker’s open); returns it.

Source

pub fn get(&self) -> Result<Option<Value>, String>

The goal now (a copy), after the document loads.

Source

pub fn close(&self)

Stops starting jobs (shutdown).

Source

pub fn command(&self, args: &str) -> Result<String, String>

/goal [objective | pause | resume | clear | check [command] | status]; returns the text to show.

Source

pub fn task_ended( &self, task_id: &str, result: Option<&Value>, ) -> Result<(), String>

A task ended (the worker’s task-end observer; result is its NativeResult): a goal job that ended early is started again when its run made progress, otherwise the goal pauses.

Source

pub fn handle_request( &self, kind: &str, payload: &Map<String, Value>, lane: &str, ) -> Result<Value, String>

One goal.* request from lane. A check runs with the lock released (it can take CHECK_TIMEOUT_SECONDS), and its result is recorded only on the goal it ran for.

Trait Implementations§

Source§

impl ApiModule for GoalDriver

Source§

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

Source§

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

Called once before the first request is served.
Source§

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

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