Struct ora_common::task::TaskDefinition

pub struct TaskDefinition<T = ()> {
    pub target: UnixNanos,
    pub worker_selector: WorkerSelector,
    pub data: Vec<u8>,
    pub data_format: TaskDataFormat,
    pub labels: HashMap<String, Value>,
    pub timeout: TimeoutPolicy,
    /* private fields */
}

An untyped complete task definition that can be added to the queue.

Fields

target: UnixNanos

The target time of the task execution.

worker_selector: WorkerSelector

The worker selector of the task.

data: Vec<u8>

Arbitrary task data that is passed to the workers.

data_format: TaskDataFormat

The input data format.

labels: HashMap<String, Value>

Arbitrary task labels.

timeout: TimeoutPolicy

An optional timeout policy.

Implementations

impl<T> TaskDefinition<T>

pub fn with_timeout(self, timeout: impl Into<TimeoutPolicy>) -> Self

Set a timeout policy.

pub fn immediate(self) -> Self

Schedule the task immediately.

pub fn at(self, target: OffsetDateTime) -> Self

Set the target execution time of the new task.

pub fn at_unix(self, target: UnixNanos) -> Self

Schedule the task at the given unix nanosecond duration.

pub fn now(self) -> Self

Schedule the task with the current time as target.

pub fn after(self, duration: Duration) -> Self

Set the target execution time of the new task to be after the given duration.

Panics

Panics if the system time is before UNIX epoch.

pub fn with_worker_selector(self, selector: impl Into<WorkerSelector>) -> Self

Set the worker selector for the given task.

pub fn with_label(self, name: &str, value: impl Serialize) -> Self

Set a label value.

Panics

Panics if the value is not JSON-serializable.

pub fn cast<U>(self) -> TaskDefinition<U>

Cast the task to a different task type, or to erase the task type replacing it with ().

This is not required in most circumstances.

Trait Implementations

impl<T> Clone for TaskDefinition<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TaskDefinition<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for TaskDefinition<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for TaskDefinition<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.