Struct amfnengine::engine::list_exchange_rate::ListExchangeRate

pub struct ListExchangeRate { /* private fields */ }

Implementations

impl ListExchangeRate

List of exchange rates implementation.

pub fn new() -> ListExchangeRate

Create and return a new list exchange rate.

Return

• See description.

pub fn add_exchange_rate(
    &mut self,
    from_code: &str,
    to_code: &str,
    exchange_rate: Decimal
) -> bool

Add a new exchange rate into the exchange rate list. The exchange rate is updated if it already exists.

Arguments

• from_code - International currency code “from”.
• to_code - International currency code “to”.
• exchange_rate - The exchange rate in “from” (unit) / “to” (unit).

Return

• True if successful, otherwise false.

pub fn copy_with_calc_manager(&self) -> ListExchangeRate

Copy all exchange rates from the exchange rate list and return a new exchange rate list.

Return

• See description.

pub fn copy(&self) -> ListExchangeRate

Copy all exchange rates from the exchange rate list and return a new exchange rate list.

Return

• See description.

pub fn convert_currency(
    &self,
    value: Decimal,
    from_code: &str,
    to_code: &str,
    cross_rate_code: &str
) -> Decimal

Convert a value from one currency to another. Cross rates are used if the exchange rate is unavailable and the cross rate international currency code is not empty.

Arguments

• value - The value to convert.
• from_code - International currency code “from”.
• to_code - International currency code “to”.
• cross_rate_code - International currency code used for cross rates.

Return

• See description.

pub fn from_code(&self) -> &str

Get the international currency code “from”.

Return

• See description.

pub fn to_code(&self) -> &str

Get the international currency code “to”.

Return

• See description.

pub fn exchange_rate(&self) -> Decimal

Get the exchange rate in “from” (unit) / “to” (unit).

Return

• See description.

pub fn get_element_by_name(&self, from_code: &str, to_code: &str) -> bool

Select a exchange rate based upon currency codes “from” and “to”.

Arguments

• from_code - International currency code “from”.
• to_code - International currency code “to”.

Return

• True if successful, otherwise false.

pub fn remove(&mut self) -> bool

Remove the selected exchange rate from the exchange rate list.

Return

• True if successful, otherwise false.

pub fn set_from_code(&mut self, from_code_param: &str) -> bool

Set the “from” international currency code.

Arguments

• from_code_param - See description.

Return

• True if successful, otherwise false.

pub fn set_to_code(&mut self, to_code_param: &str) -> bool

Set the “to” international currency code.

Arguments

• to_code - See description.

Return

• True if successful, otherwise false.

pub fn set_exchange_rate(&mut self, exchange_rate_param: Decimal) -> bool

Set the exchange rate.

Arguments

• exchange_rate_param - 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 exchange rate list is sorted.

Arguments

• sort_on_add_param - If true sort when a exchange rate 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.

Trait Implementations

impl Default for ListExchangeRate

List of exchange rates default implementation.

fn default() -> Self

Create a new symbol element.

Return

• See description.

impl ListTrait for ListExchangeRate

List of exchange rates list implementation.

fn clear(&mut self)

Clear all exchange rates from the exchange rate list.

fn count(&self) -> usize

Get the count of the exchange rate list.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected exchange rate (starting from 0).

Return

• See description.

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

Select a exchange rate based upon an index value.

Arguments

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