Struct amfnbatchlib::batch::list_batch::ListBatch

pub struct ListBatch { /* fields omitted */ }

List of batches list trait.

Implementations

impl ListBatch

List of batches implementation.

pub fn new(threads_param: usize) -> ListBatch

Create and return a new list of batches.

Arguments

• threads_param - Number of simultaneous threads to execute.

Return

• See description.

pub fn add_batch(
    &mut self,
    name_param: &str,
    group_param: &str,
    locale_param: &str,
    enabled_param: bool,
    actions_param: Vec<ElemBatchAction>,
    inputs_param: Vec<ElemBatchIO>,
    outputs_param: Vec<ElemBatchIO>
) -> bool

Add a new batch into the batches list. Duplicate batches are allowed.

Arguments

• name_param - Name of the batch.
• group_param - Optional group of the batch.
• locale_param - User locale of the batch.
• enabled_param - Enabled for execution.
• actions_param - Actions of the batch.
• inputs_param - Inputs of the batch.
• outputs_param - Outputs of the batch.

Return

• True if successful, otherwise false.

pub fn name(&self) -> &str

Get the name of the batch.

Return

• See description.

pub fn group(&self) -> &str

Get the optional group of the batch.

Return

• See description.

pub fn locale(&self) -> &str

Get the locale of the batch.

Return

• See description.

pub fn enabled(&self) -> bool

Get the enabled execution batch.

Return

• See description.

pub fn threads(&self) -> usize

Get the Number of simultaneous threads to execute.

Return

• See description.

pub fn actions(&self) -> &Vec<ElemBatchAction>

Get the list of actions.

Return

• See description.

pub fn inputs(&self) -> &Vec<ElemBatchIO>

Get the inputs of the batch.

Return

• See description.

pub fn outputs(&self) -> &Vec<ElemBatchIO>

Get the outputs of the batch.

Return

• See description.

pub fn copy_actions(&self) -> Vec<ElemBatchAction>

Copy the actions.

Return

• See description.

pub fn copy_inputs(&self) -> Vec<ElemBatchIO>

Copy the inputs.

Return

• See description.

pub fn copy_outputs(&self) -> Vec<ElemBatchIO>

Copy the outputs.

Return

• See description.

Trait Implementations

impl ListTrait for ListBatch

List of batches list trait implementation.

fn clear(&mut self)

Clear all batches from the batch list.

fn count(&self) -> usize

Get the count of the batch list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected batch (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a batch based upon an index.

Arguments

• index_param - Index of the batch to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

Return

• True if successful, otherwise false.