Struct xio_jobset::Condition

pub struct Condition {
    pub caption: String,
    pub command_type: String,
    pub exit_job: bool,
    pub parameters: BTreeMap<String, String>,
}

A condition which gets checked while a command is running.

Fields

caption: String

The caption of the condition.

command_type: String

The condition command type.

This identifies a command by it's string id which needs to be defined in the XIO commandset that gets used for compilation.

exit_job: bool

When the condition is met:

• When true, the job gets stopped with the ::xio_webapi::JobStoppedReason::ExitCriterionMatched reason.
• When false, continue job execution at the next command.

parameters: BTreeMap<String, String>

The parameters assignments.

The keys are the parameter string identifiers as defined in the XIO commandset definition for the command. The values reference the string identifier of the definition in the ParameterSet layers of the job set.

Trait Implementations

impl ExtractCaptions for Condition

type Captions = String

The type of the extracted captions.

fn extract_captions(&self) -> Self::Captions

In this method, the extraction is being processed.

impl Clone for Condition

fn clone(&self) -> Condition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Condition

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

Formats the value using the given formatter.

impl Default for Condition

fn default() -> Condition

Returns the "default value" for a type.

impl Eq for Condition

impl PartialEq for Condition

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

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

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

This method tests for !=.