Struct CurrencyPair 

pub struct CurrencyPair {
    pub base: Currency,
    pub quote: Currency,
}

An ordered currency pair, quoted as quote units per one base.

Fields

base: Currency

The base currency — the one unit being priced.

quote: Currency

The quote currency — what it is priced in.

Implementations

impl CurrencyPair

pub fn new(base: Currency, quote: Currency) -> Self

The pair base/quote.

pub fn inverse(self) -> Self

This pair the other way round.

Trait Implementations

impl Clone for CurrencyPair

fn clone(&self) -> CurrencyPair

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CurrencyPair

impl Debug for CurrencyPair

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

Formats the value using the given formatter.

impl Display for CurrencyPair

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

Formats the value using the given formatter.

impl Eq for CurrencyPair

impl FromStr for CurrencyPair

The inverse of Display: BASE/QUOTE, and the market’s unslashed BASEQUOTE spelling too. Two distinct currencies.

type Err = CurrencyPairParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CurrencyPair

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CurrencyPair

Ordered by the two codes, so a store’s pairs sort predictably and a lookup can binary-search them. Currency itself carries no order — it is a validated three-byte code, and nothing below this layer needs to sort one.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CurrencyPair

fn eq(&self, other: &CurrencyPair) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CurrencyPair

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for CurrencyPair