Struct RustQuant::instruments::fx::currency::Currency

pub struct Currency {
    pub name: &'static str,
    pub symbol: &'static str,
    pub code: ISO_4217,
    pub minor: usize,
    pub fractions: usize,
}

Currency data struct.

Fields

name: &'static str

Currency name. e.g. United States Dollar

symbol: &'static str

Currency symbol. e.g. $

code: ISO_4217

ISO 4217 currency code. e.g. USD = 840

minor: usize

Minor unit: digits after decimal separator. Usually D = 2.

fractions: usize

Fractions per unit. e.g. 100 cents = 1 dollar.

Implementations

impl Currency

pub fn new( name: &'static str, symbol: &'static str, code: ISO_4217, minor: usize, fractions: usize ) -> Self

Create a new currency.

pub fn name(&self) -> &str

Get the currency name.

pub fn symbol(&self) -> &str

Get the currency symbol.

pub fn code(&self) -> ISO_4217

Get the currency code.

pub fn minor(&self) -> usize

Get the minor unit.

pub fn fractions(&self) -> usize

Get the fractions per unit.

Trait Implementations

impl Clone for Currency

fn clone(&self) -> Currency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Currency

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

Formats the value using the given formatter.

impl Display for Currency

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

Formats the value using the given formatter.

impl Instrument for Currency

fn price(&self) -> f64

Returns the price (net present value) of the instrument.

fn error(&self) -> Option<f64>

Returns the error on the NPV in case the pricing engine can provide it (e.g. Monte Carlo pricing engine).

fn valuation_date(&self) -> Date

Returns the date at which the NPV is calculated.

fn instrument_type(&self) -> &'static str

Instrument type.

impl PartialEq for Currency

fn eq(&self, other: &Self) -> 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 Copy for Currency

impl Eq for Currency