Struct mcai_models::Step

pub struct Step {

    pub icon: Icon,
    pub id: u32,
    pub label: String,
    pub name: String,
    pub parameters: Vec<Parameter>,
    pub mode: StepMode,
    pub multiple_jobs: Option<String>,
    pub condition: Option<String>,
    pub skip_destination_path: bool,
    pub parent_ids: Vec<u32>,
    pub required_to_start: Vec<u32>,
    pub work_dir: Option<String>,
    pub jobs: Option<JobsStatus>,
    pub coordinates: Option<Coordinates>,
}

Definition of a step

Fields

icon: Icon

The icon for this step

id: u32

Unique identifier of this step in a workflow

label: String

Displayed name of this step

name: String

Queue name for this step, it select the worker

parameters: Vec<Parameter>

List of all parameters for this step

mode: StepMode

Mode for this step

multiple_jobs: Option<String>

Name of the variable which contain data ranges to process splitted media by part

condition: Option<String>

Expression which requires to return a boolean. On false condition, the step will be skipped.

skip_destination_path: bool

Skip generation of a destination path parameter, it requires to add it in parameters

parent_ids: Vec<u32>

Reference(s) of parent steps It is used to generate the input paths list from all parents destination paths

required_to_start: Vec<u32>

Reference(s) of required steps to start the process of that step

work_dir: Option<String>

Overwrite the default workdir for this step

jobs: Option<JobsStatus>

Jobs status for this step

coordinates: Option<Coordinates>

Coordinates for this step

Implementations

impl Step

pub fn add_parent(&mut self, parent_id: &u32)

pub fn add_required(&mut self, required_id: &u32)

pub fn set_parameter(
    &mut self,
    field_name: &str,
    new_value: ParameterType
) -> bool

Trait Implementations

impl Clone for Step

fn clone(&self) -> Step

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Step

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Step

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Step

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq<Step> for Step

fn eq(&self, other: &Step) -> 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 Serialize for Step

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Step