Struct amfnbatchlib::batch::list_batch::ListBatch

[−]

pub struct ListBatch { /* private fields */ }

Expand description

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>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the list of actions.

Return

See description.

pub fn inputs(&self) -> &Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the inputs of the batch.

Return

See description.

pub fn outputs(&self) -> &Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the outputs of the batch.

Return

See description.

pub fn copy_actions(&self) -> Vec<ElemBatchAction>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Copy the actions.

Return

See description.

pub fn copy_inputs(&self) -> Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Copy the inputs.

Return

See description.

pub fn copy_outputs(&self) -> Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

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.

Auto Trait Implementations

impl !RefUnwindSafe for ListBatch

impl Send for ListBatch

impl !Sync for ListBatch

impl Unpin for ListBatch

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct amfnbatchlib::batch::list_batch::ListBatch

Implementations

impl ListBatch

pub fn new(threads_param: usize) -> ListBatch

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

pub fn name(&self) -> &str

pub fn group(&self) -> &str

pub fn locale(&self) -> &str

pub fn enabled(&self) -> bool

pub fn threads(&self) -> usize

pub fn actions(&self) -> &Vec<ElemBatchAction>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn inputs(&self) -> &Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn outputs(&self) -> &Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn copy_actions(&self) -> Vec<ElemBatchAction>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn copy_inputs(&self) -> Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn copy_outputs(&self) -> Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

Trait Implementations

impl ListTrait for ListBatch

fn clear(&mut self)

fn count(&self) -> usize

fn index(&self) -> usize

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

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

Auto Trait Implementations

impl !RefUnwindSafe for ListBatch

impl Send for ListBatch

impl !Sync for ListBatch

impl Unpin for ListBatch

impl UnwindSafe for ListBatch

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn actions(&self) -> &Vec<ElemBatchAction>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn inputs(&self) -> &Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn outputs(&self) -> &Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn copy_actions(&self) -> Vec<ElemBatchAction>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn copy_inputs(&self) -> Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn copy_outputs(&self) -> Vec<ElemBatchIO>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,