Struct amfnengine::core::list_descriptor::ListDescriptor

pub struct ListDescriptor { /* private fields */ }

Implementations

impl ListDescriptor

List of descriptors implementation.

pub fn new() -> ListDescriptor

Create a new descriptor list.

Arguments

• elem_level_param - Element level

Return

• See description.

pub fn add_descriptor(
    &mut self,
    group_param: &str,
    name_param: &str,
    desc_type_param: &str,
    code_param: &str,
    value_param: String,
    value_expr_param: &str,
    propagate_param: bool,
    updating_json_param: bool
) -> bool

Add a new descriptor into the descriptor list. If the name results in a duplicate entry, an incrementing number starting from 2 is appended to the name until a non-duplicate entry is found.

Arguments

• group_param - Descriptor group.
• name_param - Descriptor name.
• desc_type_param - Descriptor type.
• code_param - Descriptor code.
• value_param - Value parameter.
• value_expr_param - Value expression.
• propagate_param - Propogate descriptor.
• updating_json_param - Updating from json.

Return

• True if successful, otherwise false.

pub fn copy(
    &self,
    copy_propagate: bool,
    updating_json_param: bool
) -> ListDescriptor

Performs a deep copy of this descriptor list and returns and new descriptor list.

Arguments

• copy_propagate - Copy only descriptors marked as “propagate” (otherwise copy all descriptors).
• elem_level_param - Element level
• updating_json_param - Updating from json.

Return

• See description.

pub fn copy_list_descriptor(
    &self,
    list_descriptor: &mut ListDescriptor,
    copy_propagate: bool,
    updating_json_param: bool
)

Performs a deep copy of this descriptor list into the descriptor list parameter.

Arguments

• list_descriptor - The descriptor list to copy into.
• copy_propagate - Copy only descriptors marked as “propagate” (otherwise copy all descriptors).
• updating_json_param - Updating from json

pub fn equal(&self, list_descriptor: &ListDescriptor) -> bool

Tests if this descriptor list and another are equal.

Arguments

• list_descriptor - List to compare.

Return

• True if equals, otherwise false.

pub fn group(&self) -> &str

Get the group name of the descriptor.

Return

• See description.

pub fn name(&self) -> &str

Get the name of the descriptor.

Return

• See description.

pub fn desc_type(&self) -> &str

Get the type of descriptor.

Return

• See description.

pub fn code(&self) -> &str

Get the code for the type of descriptor.

Return

• See description.

pub fn value(&self) -> String

Get the constant value or the result of an expression.

Return

• See description.

pub fn value_expr(&self) -> String

Get the optional value expression.

Return

• See description.

pub fn propagate(&self) -> bool

Get the propagate to the next level if applicable.

Return

• See description.

pub fn list_event_index(&self) -> usize

Get the index of the event within the event list.

Return

• See description.

pub fn get_element_by_name(
    &self,
    group_param: &str,
    name_param: &str,
    type_param: &str,
    code_param: &str,
    select_param: bool
) -> bool

Select a descriptor based upon a group, name, type, and code.

Arguments

• group_param - Group to find.
• name_param - Name to find.
• type_param - Type to find.
• code_param - Code to find.
• select_param - Select the found element, otherwise just return result.

Return

• True if successful, otherwise false.

pub fn remove(&mut self) -> bool

Remove the selected descriptor from the descriptor list.

Return

• True if successful, otherwise false.

pub fn set_group(&mut self, group: &str) -> bool

Set the group name of the descriptor. Duplicate group/name are not allowed.

Arguments

• group - See description.

Return

• True if successful, otherwise false.

pub fn set_name(&mut self, name: &str) -> bool

Set the name of the descriptor. Duplicate group/name are not allowed.

Arguments

• name - See description.

Return

• True if successful, otherwise false.

pub fn set_type(&mut self, desc_type: &str) -> bool

Set the type of descriptor.

Arguments

• desc_type - See description.

Return

• True if successful, otherwise false.

pub fn set_code(&mut self, code: &str) -> bool

Set the code for the type of descriptor.

Arguments

• code - See description.

Return

• True if successful, otherwise false.

pub fn set_value(&self, value: &str) -> bool

Set the constant value.

Arguments

• value - See description.

Return

• True if successful, otherwise false.

pub fn set_value_result(&mut self, value: &str) -> bool

Set the result of an expression.

Arguments

• value - See description.

Return

• True if successful, otherwise false.

pub fn set_value_expr(&mut self, value_expr: &str) -> bool

Set the optional value expression.

Arguments

• value_expr - See description.

Return

• True if successful, otherwise false.

pub fn set_propagate(&mut self, propagate: bool) -> bool

Set the propagate to the next level if applicable.

Arguments

• propagate - See description.

Return

• True if successful, otherwise false.

pub fn set_list_event_index(&self, list_event_index: usize) -> bool

Set the index of the event within the event list.

Arguments

• list_event_index - See description.

Return

• True if successful, otherwise false.

pub fn set_sort_on_add(&mut self, sort_on_add_param: bool) -> bool

Determines when the descriptor list is sorted.

Arguments

• sort_on_add_param - If true sort when a descriptor is added, otherwise do not sort (for bulk adds).

Return

• True if successful, otherwise false.

pub fn set_sort_updated(&mut self, sort_updated_param: bool) -> bool

Set sort updated.

Arguments

• sort_updated_param - If true sort updated otherwise false.

Return

• True if successful, otherwise false.

Trait Implementations

impl Default for ListDescriptor

List of descriptors default implementation.

fn default() -> Self

Create a new symbol element.

Return

• See description.

impl ListTrait for ListDescriptor

List of descriptors list implementation.

fn clear(&mut self)

Clear all descriptors from the descriptor list.

fn count(&self) -> usize

Get the count of the descriptor list.

Return

• See description.

fn index(&self) -> usize

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

Return

• See description.

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

Select a descriptor based upon an index value.

Arguments

• index_param - The index value of the descriptor 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.