Struct sacs::job::JobId

#[non_exhaustive]
pub struct JobId {
    pub id: Uuid,
    pub task_id: TaskId,
}

JobId uniquely identifies running instance of Task.

You don’t need to construct this object manually:

• task_id is provided from Scheduler during planned starting of the Task instance,
• job_id is a created automatically Uuid.

Executor creates JobId for each running job and provides it to job’s closure as a parameter (id in the example below).

String representation of the JobId is "{task_id}/{id}".

Common usage of JobId inside task closure is for logging.

Examples

use sacs::task::{Task, TaskSchedule};
use std::time::Duration;

let task = Task::new(TaskSchedule::Once, |id| {
    Box::pin(async move {
        println!("Starting job, TaskId={}, JobId={}.", id.task_id, id.id);
        // Actual async workload here
        tokio::time::sleep(Duration::from_secs(1)).await;
        // ...
        println!("Job {id} finished.");
        })
    });

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Uuid

Unique ID of the running Job within particular Task.

task_id: TaskId

ID of the Task which owns this Job, is provided from Scheduler during scheduled starting of the Task instance.

Trait Implementations

impl Clone for JobId

fn clone(&self) -> JobId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobId

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

Formats the value using the given formatter.

impl Display for JobId

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

Formats the value using the given formatter.

impl From<&TaskId> for JobId

fn from(value: &TaskId) -> Self

Converts to this type from the input type.

impl From<JobId> for String

fn from(value: JobId) -> Self

Converts to this type from the input type.

impl From<TaskId> for JobId

fn from(value: TaskId) -> Self

Converts to this type from the input type.

impl Hash for JobId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for JobId

fn cmp(&self, other: &JobId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for JobId

fn eq(&self, other: &JobId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for JobId

fn partial_cmp(&self, other: &JobId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for JobId

impl StructuralPartialEq for JobId