Enum xio_webapi::JobEvent

pub enum JobEvent {
    Started {
        job: String,
        tags: IndexMap<String, Vec<String>>,
        instant: u64,
    },
    Data {
        tag: String,
        values: Vec<DataValueDescriptive>,
        instant: u64,
    },
    Position {
        command: u16,
        message: String,
        description: String,
        instant: u64,
    },
    Stopped {
        details: JobStoppedReason,
        instant: u64,
    },
}

An enum representing events that can occur during job execution.

Variants

Started

Execution of a job has started.

Fields of Started

job: String

The job identifier string.

tags: IndexMap<String, Vec<String>>

A definition of the tags and the field names for each tag.

instant: u64

The number of milliseconds since the job started.

Data

A data row was recorded.

Fields of Data

tag: String

The tag of the data.

values: Vec<DataValueDescriptive>

The data values.

The values are sorted in the same order as the tags field by the JobEvent::Started variant.

instant: u64

The number of milliseconds since the job started.

Position

The job execution has reached a new position.

Fields of Position

command: u16

The command position index.

message: String

The message string of the current position.

description: String

The description string of the current position.

instant: u64

The number of milliseconds since the job started.

Stopped

The currently running job has stopped.

Fields of Stopped

details: JobStoppedReason

The details about why the job has stopped.

instant: u64

The number of milliseconds since the job started.

Methods

impl JobEvent

pub fn instant(&self) -> u64

Get the instant of the event (in milliseconds since job start).

pub fn instant_duration(&self) -> Duration

Get the instant of the event (duration since job start).

Trait Implementations

impl Eq for JobEvent

impl Clone for JobEvent

fn clone(&self) -> JobEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<JobEvent> for JobEvent

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

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

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

This method tests for !=.

impl Debug for JobEvent

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

Formats the value using the given formatter.

impl Serialize for JobEvent

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for JobEvent

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

Deserialize this value from the given Serde deserializer.