Struct Instrument 

pub struct Instrument { /* private fields */ }

Instrument.

Implementations

impl Instrument

pub fn try_new( symbol: &str, base: &Asset, quote: &Asset, ) -> Result<Instrument, ParseSymbolError>

Create a new instrument. Return ParseSymbolError if the format of the symbol is not valid.

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

Create a new spot.

pub fn derivative( prefix: &str, symbol: &str, base: &Asset, quote: &Asset, ) -> Result<Instrument, ParseSymbolError>

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

Warning

User must make sure that inst1.symbol == inst2.symbol only if inst1.base == inst2.base && inst1.quote == inst2.quote.

pub fn to_reversed_spot(&self) -> Option<Instrument>

Convert to the revsered spot. Return None if it is not a spot.

pub fn try_with_symbol( symbol: Symbol, base: &Asset, quote: &Asset, ) -> Result<Instrument, ParseSymbolError>

Create a new instrument with the given symbol. Return ParseSymbolError if the symbol does not match the given base or quote.

Warning

User must make sure that inst1.symbol == inst2.symbol only if inst1.base == inst2.base && inst1.quote == inst2.quote.

pub fn prefer_reversed(self, reversed: bool) -> Instrument

Whether to mark this instrument as a reversed-prefering. Default to false.

pub fn is_prefer_reversed(&self) -> bool

Is this instrument reversed-prefering. Default to false.

pub fn as_symbol(&self) -> &Symbol

Get the symbol.

pub fn is_spot(&self) -> bool

Is spot.

pub fn is_derivative(&self) -> bool

Is derivative.

pub fn base(&self) -> &Asset

Get the base asset.

pub fn quote(&self) -> &Asset

Get the quote asset.

pub fn position<T, P>(&self, position: P) -> Position<T>

where T: PositionNum, P: IntoNaivePosition<T>,

Create a Position with the given position of this instrument.

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 Instrument

fn clone(&self) -> Instrument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instrument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instrument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Instrument

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

Formats the value using the given formatter.

impl From<(Asset, Asset)> for Instrument

fn from(_: (Asset, Asset)) -> Instrument

Converts to this type from the input type.

impl Hash for Instrument

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 Instrument

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

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

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

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 Eq for Instrument