Enum xio_webapi::JobEvent [−][src]
pub enum JobEvent { Started { job: String, tags: BTreeMap<String, Vec<String>>, instant: u64, }, Data { tag: String, values: Vec<DataValueDescriptive>, instant: u64, }, Position { command: u16, caption: 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. |
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 |
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. |
The caption 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
[src]
impl JobEvent
pub fn instant(&self) -> u64
[src]
pub fn instant(&self) -> u64
Get the instant of the event (in milliseconds since job start).
pub fn instant_duration(&self) -> Duration
[src]
pub fn instant_duration(&self) -> Duration
Get the instant of the event (duration since job start).
Trait Implementations
impl Clone for JobEvent
[src]
impl Clone for JobEvent
fn clone(&self) -> JobEvent
[src]
fn clone(&self) -> JobEvent
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for JobEvent
[src]
impl Debug for JobEvent
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for JobEvent
[src]
impl PartialEq for JobEvent
fn eq(&self, other: &JobEvent) -> bool
[src]
fn eq(&self, other: &JobEvent) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &JobEvent) -> bool
[src]
fn ne(&self, other: &JobEvent) -> bool
This method tests for !=
.
impl Eq for JobEvent
[src]
impl Eq for JobEvent