Struct barter_integration::Instrument

pub struct Instrument {
    pub base: Symbol,
    pub quote: Symbol,
    pub kind: InstrumentKind,
}

Barter representation of an Instrument. Used to uniquely identify a base_quote pair, and it’s associated instrument type.

eg/ Instrument { base: “btc”, quote: “usdt”, kind: Spot }

Fields

base: Symbol

quote: Symbol

kind: InstrumentKind

Implementations

impl Instrument

pub fn new<S>(base: S, quote: S, kind: InstrumentKind) -> Self where
    S: Into<Symbol>, 

Constructs a new Instrument using the provided configuration.

pub fn to_id(&self, exchange: &str) -> InstrumentId

Generates a unique identifier for an Instrument being traded on the provided exchange.

Trait Implementations

impl Clone for Instrument

fn clone(&self) -> Instrument

Returns a copy 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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for Instrument

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

Formats the value using the given formatter.

impl<S> From<(S, S, InstrumentKind)> for Instrument where
    S: Into<Symbol>, 

fn from((base, quote, kind): (S, S, InstrumentKind)) -> Self

Converts to this type from the input type.

impl Hash for Instrument

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, 

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Instrument> for Instrument

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Instrument> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Instrument

impl StructuralEq for Instrument

impl StructuralPartialEq for Instrument