Skip to main content

Job

Struct Job 

Source
pub struct Job<D = ()> {
    pub job_id: String,
    pub execution_resource_id: String,
    pub guard_scope: ExecutionGuardScope,
    pub schedule: Schedule,
    pub time_window: Option<JobTimeWindow>,
    pub max_runs: Option<u32>,
    pub missed_run_policy: MissedRunPolicy,
    pub overlap_policy: OverlapPolicy,
    /* private fields */
}

Fields§

§job_id: String§execution_resource_id: String§guard_scope: ExecutionGuardScope§schedule: Schedule§time_window: Option<JobTimeWindow>§max_runs: Option<u32>§missed_run_policy: MissedRunPolicy§overlap_policy: OverlapPolicy

Implementations§

Source§

impl Job<()>

Source

pub fn without_deps( job_id: impl Into<String>, schedule: Schedule, task: Task<()>, ) -> Self

Create a job that uses no injected dependencies.

Source§

impl<D> Job<D>
where D: Send + Sync + 'static,

Source

pub fn new( job_id: impl Into<String>, schedule: Schedule, deps: impl Into<Arc<D>>, task: Task<D>, ) -> Self

Create a job from explicit dependencies and a task handler.

Source§

impl<D> Job<D>

Source

pub fn with_max_runs(self, max_runs: u32) -> Self

Limit how many triggers this job can consume before it exits.

This applies to Schedule::Interval, Schedule::AtTimes, and Schedule::Cron. A value of 0 makes the job exit immediately without running.

Source

pub fn with_missed_run_policy(self, policy: MissedRunPolicy) -> Self

Source

pub fn with_overlap_policy(self, policy: OverlapPolicy) -> Self

Source

pub fn with_time_window(self, time_window: JobTimeWindow) -> Self

Source

pub fn with_execution_resource_id(self, resource_id: impl Into<String>) -> Self

Source

pub fn with_guard_scope(self, scope: ExecutionGuardScope) -> Self

Trait Implementations§

Source§

impl<D: Clone> Clone for Job<D>

Source§

fn clone(&self) -> Job<D>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<D> Debug for Job<D>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<D> Freeze for Job<D>

§

impl<D = ()> !RefUnwindSafe for Job<D>

§

impl<D> Send for Job<D>
where D: Sync + Send,

§

impl<D> Sync for Job<D>
where D: Sync + Send,

§

impl<D> Unpin for Job<D>

§

impl<D> UnsafeUnpin for Job<D>

§

impl<D = ()> !UnwindSafe for Job<D>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.