trade 0.1.0

Utilities for trading on crypto-currencies exchanges.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! A module defining the `Symbol` type.

use std::ops::Deref;
use arrayvec::ArrayString;
use serde_derive::{Serialize, Deserialize};
use crate::tick::Tick;

/// A small string type used for symbol names.
pub type SymbolName = ArrayString<[u8; 10]>;

#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug, Serialize, Deserialize)]
/// A type carrying information about a traded symbol.
pub struct Symbol {
    name: SymbolName,
    price_tick: Tick,
    size_tick: Tick,
    commission_tick: Tick,
}

impl Symbol {
    crate fn new(name: &str, price_tick: Tick, size_tick: Tick) -> Option<Self> {
        Some(Symbol {
            name: SymbolName::from(name).ok()?,
            price_tick,
            size_tick,
            commission_tick: Tick::new(1),
        })
    }

    /// Symbol name.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Price tick of the symbol quotes.
    pub fn price_tick(&self) -> Tick {
        self.price_tick
    }

    /// Size tick of the symbol orders.
    pub fn size_tick(&self) -> Tick {
        self.size_tick
    }

    /// Not used for now.
    pub fn commission_tick(&self) -> Tick {
        self.commission_tick
    }
}

#[derive(Clone, PartialEq, Eq, Hash, Debug)]
/// Wrapper around a type carrying additional information about a symbol. Deref to `T`.
pub struct WithSymbol<T> {
    symbol: Symbol,
    inner: T,
}

impl<T> WithSymbol<T> {
    /// Carried symbol.
    pub fn symbol(&self) -> Symbol {
        self.symbol
    }

    /// Return the wrapped value.
    pub fn into_inner(self) -> T {
        self.inner
    }
}

impl<T> Deref for WithSymbol<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

/// Wrap `Self` in a `WithSymbol<&Self>`.
pub trait IntoWithSymbol: Sized {
    /// Add the given `symbol` to a borrowed `&self`.
    fn with_symbol(&self, symbol: Symbol) -> WithSymbol<&Self> {
        WithSymbol {
            symbol,
            inner: self,
        }
    }
}

impl<T: Sized> IntoWithSymbol for T { }