Skip to main content

Task

Struct Task 

Source
pub struct Task<I, O> { /* private fields */ }
Expand description

A task is a unit of work that can be executed by a worker. See Hatchet.task() for more information.

Implementations§

Source§

impl<I, O> Task<I, O>
where I: Serialize + for<'de> Deserialize<'de> + Send + 'static, O: Serialize + Send + 'static,

Source

pub fn add_parent<J, P>(self, parent: &Task<J, P>) -> Self

Source

pub async fn schedule( &self, trigger_at: DateTime<Utc>, input: &I, options: Option<&ScheduleOptions>, ) -> Result<ScheduledRun, HatchetError>

Schedule this task’s workflow to run at a specific future time. See SchedulesClient::create for the underlying API.

Source

pub async fn cron( &self, name: &str, expression: &str, input: &I, options: Option<&CronOptions>, ) -> Result<CronTrigger, HatchetError>

Create a recurring cron trigger for this task’s workflow. See CronsClient::create for the underlying API.

Trait Implementations§

Source§

impl<I: Clone, O: Clone> Clone for Task<I, O>

Source§

fn clone(&self) -> Task<I, O>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<I, O> Register<Task<I, O>, I, O> for Worker
where I: DeserializeOwned + Serialize + Send + Sync + 'static, O: Serialize + DeserializeOwned + Send + Sync + 'static,

Source§

fn add_task_or_workflow(self, workflow: &Task<I, O>) -> Self

Source§

impl<I, O> Runnable<I, O> for Task<I, O>
where I: Serialize + DeserializeOwned + Send + Sync + 'static, O: Serialize + DeserializeOwned + Send + Sync + 'static,

Source§

fn get_run<'life0, 'life1, 'async_trait>( &'life0 self, run_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<GetWorkflowRunResponse, HatchetError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Source§

fn run_no_wait<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, input: &'life1 I, options: Option<&'life2 TriggerWorkflowOptions>, ) -> Pin<Box<dyn Future<Output = Result<String, HatchetError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Source§

fn run<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, input: &'life1 I, options: Option<&'life2 TriggerWorkflowOptions>, ) -> Pin<Box<dyn Future<Output = Result<O, HatchetError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Auto Trait Implementations§

§

impl<I, O> !Freeze for Task<I, O>

§

impl<I, O> !RefUnwindSafe for Task<I, O>

§

impl<I, O> Send for Task<I, O>

§

impl<I, O> Sync for Task<I, O>

§

impl<I, O> Unpin for Task<I, O>

§

impl<I, O> UnsafeUnpin for Task<I, O>

§

impl<I, O> !UnwindSafe for Task<I, O>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
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