Struct Symbol 

pub struct Symbol(/* private fields */);

Symbol.

Implementations

impl Symbol

pub const SPOT_PREFIX: SmolStr

Empty str, the prefix of spot instruments.

pub const SEP: char = ':'

The delimiter of prefix and symbol.

pub fn is_derivative(&self) -> bool

Is a derivative.

pub fn as_derivative(&self) -> Option<(&str, &str)>

Get the prefix and the symbol of the derivative. Return None if it is not a derivative.

pub fn derivative_prefix(&self) -> Option<&str>

Get the prefix of the derivative. Spots has no prefix.

pub fn derivative_symbol(&self) -> Option<&str>

Get the symbol of the derivative. Return None if it is not a derivative.

pub fn is_spot(&self) -> bool

Is a spot.

pub fn as_spot(&self) -> Option<(&Asset, &Asset)>

As a pair of assets. Return None if it is not a spot.

pub fn spot(base: &Asset, quote: &Asset) -> Symbol

Create a spot symbol.

pub fn to_reversed_symbol(&self) -> Option<Symbol>

Get the reversed spot. Return None if it is not a spot.

pub fn derivative( prefix: &str, symbol: &str, ) -> Result<Symbol, ParseSymbolError>

Create a derivative symbol. Return ParseSymbolError if the prefix is not valid.

Trait Implementations

impl AsRef<Symbol> for Instrument

fn as_ref(&self) -> &Symbol

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Borrow<Symbol> for &'a Instrument

fn borrow(&self) -> &Symbol

Immutably borrows from an owned value.

impl Borrow<Symbol> for Instrument

fn borrow(&self) -> &Symbol

Immutably borrows from an owned value.

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 From<ExcSymbol> for Symbol

fn from(symbol: ExcSymbol) -> Symbol

Converts to this type from the input type.

impl FromStr for Symbol

type Err = ParseSymbolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Symbol, <Symbol as FromStr>::Err>

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

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 Ord for Symbol

fn cmp(&self, other: &Symbol) -> 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<Symbol> for Instrument

fn eq(&self, other: &Symbol) -> 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 PartialEq for Symbol

fn eq(&self, other: &Symbol) -> 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 Symbol

fn partial_cmp(&self, other: &Symbol) -> 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 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<'a> TryFrom<&'a str> for Symbol

type Error = ParseSymbolError

The type returned in the event of a conversion error.

fn try_from( value: &'a str, ) -> Result<Symbol, <Symbol as TryFrom<&'a str>>::Error>

Performs the conversion.

impl TryFrom<SmolStr> for Symbol

type Error = ParseSymbolError

The type returned in the event of a conversion error.

fn try_from( value: SmolStr, ) -> Result<Symbol, <Symbol as TryFrom<SmolStr>>::Error>

Performs the conversion.

impl Eq for Symbol

impl StructuralPartialEq for Symbol