Skip to main content

CronBuilder

Struct CronBuilder 

Source
pub struct CronBuilder<T: TaskHandler> { /* private fields */ }
Expand description

Builder for a typed cron entry.

Implementations§

Source§

impl<T: TaskHandler> CronBuilder<T>

Source

pub fn new(timer: CrontabTimer) -> Self

Build a typed cron entry from a custom timer.

Source

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

Set a stable identifier for this cron entry.

Use this when more than one schedule targets the same task.

Source

pub fn fill(self, fill: CrontabFill) -> Self

Backfill missed executions for the given duration.

Source

pub fn max_attempts(self, max_attempts: u16) -> Self

Override the maximum number of attempts for jobs created by this cron.

Source

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

Add jobs created by this cron to a named queue.

Source

pub fn priority(self, priority: i16) -> Self

Override the priority for jobs created by this cron.

Source

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

Set a job key for deduplication.

Source

pub fn job_key_mode(self, job_key_mode: JobKeyMode) -> Self

Set the behavior for an existing job with the same job key.

Source

pub fn payload(self, payload: T) -> Result<Self, Error>

Serialize a typed task payload for jobs created by this cron.

Source

pub fn payload_value(self, payload: impl Into<Value>) -> Self

Set a pre-built JSON payload for jobs created by this cron.

Source

pub fn build(self) -> Crontab

Finish the builder and return the lower-level crontab value.

Trait Implementations§

Source§

impl<T: Clone + TaskHandler> Clone for CronBuilder<T>

Source§

fn clone(&self) -> CronBuilder<T>

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<T: TaskHandler> CronInput for CronBuilder<T>

Source§

impl<T: Debug + TaskHandler> Debug for CronBuilder<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: TaskHandler> From<CronBuilder<T>> for Crontab

Source§

fn from(builder: CronBuilder<T>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> Freeze for CronBuilder<T>

§

impl<T> RefUnwindSafe for CronBuilder<T>

§

impl<T> Send for CronBuilder<T>

§

impl<T> Sync for CronBuilder<T>

§

impl<T> Unpin for CronBuilder<T>

§

impl<T> UnsafeUnpin for CronBuilder<T>

§

impl<T> UnwindSafe for CronBuilder<T>

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> AnyClone for T
where T: Clone + Send + Sync + Debug + 'static,

Source§

fn clone_box(&self) -> Box<dyn AnyClone + Sync + Send>

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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