Struct Pair

pub struct Pair {
    pub base: String,
    pub quote: String,
}

A pair of assets, e.g. BTC/USD

This is a simple struct that holds the base and quote assets. It is used to represent a pair of assets in the system. Base and quote are always in UPPERCASE.

Fields

base: String

quote: String

Implementations

impl Pair

pub fn create_routed_pair(base_pair: &Self, quote_pair: &Self) -> Self

Creates a routed pair from two pairs that share a common quote currency.

e.g. “BTC/USD” and “ETH/USD” -> “BTC/ETH”

pub fn from_currencies(base: &str, quote: &str) -> Self

Creates a new pair from base and quote currencies.

pub fn from_stable_pair(pair: &str) -> Option<Self>

Creates a pair from a stable pair string with or without delimiters e.g. “BTCUSDT” -> BTC/USD, “ETH-USDC” -> ETH/USD, “SOL_USDT” -> SOL/USD

pub fn as_tuple(&self) -> (String, String)

Get the base and quote as a tuple

pub fn format_with_separator(&self, separator: &str) -> String

Format pair with a custom separator

pub fn to_pair_id(&self) -> String

Get the pair ID in standard format without consuming self

Trait Implementations

impl Clone for Pair

fn clone(&self) -> Pair

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pair

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

Formats the value using the given formatter.

impl Default for Pair

fn default() -> Pair

Returns the “default value” for a type.

impl Display for Pair

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

Formats the value using the given formatter.

impl From<Pair> for String

fn from(pair: Pair) -> Self

Converts to this type from the input type.

impl FromStr for Pair

type Err = Error

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 Pair

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 PartialEq for Pair

fn eq(&self, other: &Pair) -> 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 TryFrom<&str> for Pair

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pair_id: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<(String, String)> for Pair

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pair: (String, String)) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Pair

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pair_id: String) -> Result<Self>

Performs the conversion.

impl Eq for Pair

impl StructuralPartialEq for Pair