Struct Symbol 

pub struct Symbol { /* private fields */ }

A canonical, venue-neutral market: a base asset against a quote asset.

Assets are upper-cased on construction so Symbol comparisons and hashing are case-insensitive. The canonical text form is BASE/QUOTE (e.g. BTC/USDT); FromStr also accepts a - separator.

Implementations

impl Symbol

pub fn new(base: impl Into<String>, quote: impl Into<String>) -> Symbol

Build a symbol from a base and quote asset. Both are upper-cased.

pub fn base(&self) -> &str

The base asset (e.g. BTC in BTC/USDT).

pub fn quote(&self) -> &str

The quote asset (e.g. USDT in BTC/USDT).

pub fn to_concatenated(&self) -> String

Render as a concatenated pair with no separator, e.g. BTCUSDT. This is the most common venue wire form; modules that need a different spelling (a separator, an alias such as XBT) map from the base/quote parts.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Symbol

fn deserialize<__D>( __deserializer: __D, ) -> Result<Symbol, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl FromStr for Symbol

fn from_str(s: &str) -> Result<Symbol, Error>

Parse BASE/QUOTE or BASE-QUOTE. The separator is required because a bare concatenation (BTCUSDT) cannot be split unambiguously without the venue’s asset list.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Symbol

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

where __H: Hasher,

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 Symbol

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Symbol

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Symbol