polyoxide-binance 0.45.0

Rust client library for Binance USDⓈ-M futures and spot market data and streams
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

//! # polyoxide-binance
//!
//! Rust client library for Binance's APIs, one feature per module: `usdm` and `spot`.
//!
//! `usdm` (feature `usdm`, on by default) reads USDⓈ-M futures public market
//! data (`fapi.binance.com`), and with `usdm-ws` its market streams
//! (`fstream.binance.com`). `spot` (feature `spot`, on by default) reads spot
//! public market data (`api.binance.com`), and with `spot-ws` its market
//! streams (`stream.binance.com`). No credentials are needed. Each module's
//! own docs carry its example.

// Compile the crate README's `rust` code fences as doctests so broken examples
// fail CI. `doctest` keeps this out of normal builds and `cargo doc`.
#[cfg(all(doctest, feature = "usdm"))]
#[doc = include_str!("../README.md")]
struct ReadmeDoctests;

// Each module's README is a doctest under its own feature, as the crate's is.
// `.github/scripts/tests/test_module_readmes.py` fails when a module README
// has no include here, or an include names no README.
#[cfg(all(doctest, feature = "usdm"))]
#[doc = include_str!("usdm/README.md")]
struct UsdmReadmeDoctests;

#[cfg(all(doctest, feature = "spot"))]
#[doc = include_str!("spot/README.md")]
struct SpotReadmeDoctests;

#[cfg(any(feature = "usdm", feature = "spot"))]
mod shared;

#[cfg(feature = "usdm")]
pub mod usdm;

#[cfg(feature = "spot")]
pub mod spot;

// Every public error type implements `Classify`; one without it fails the
// build here. `.github/scripts/tests/test_classify_coverage.py` fails when a
// public error type is missing from this list.
#[cfg(feature = "usdm")]
const _: fn() = || {
    fn is<T: polyoxide_venue::Classify>() {}
    is::<usdm::UsdmError>();
    is::<usdm::types::InvalidSymbol>();
    #[cfg(feature = "usdm-ws")]
    is::<usdm::ws::UsdmWsError>();
    #[cfg(feature = "usdm-ws")]
    is::<usdm::ws::InvalidStreamName>();
};

// The spot module's error types, in the same assertion `usdm`'s are in.
#[cfg(feature = "spot")]
const _: fn() = || {
    fn is<T: polyoxide_venue::Classify>() {}
    is::<spot::SpotError>();
    is::<spot::types::InvalidSymbol>();
    #[cfg(feature = "spot-ws")]
    is::<spot::ws::SpotWsError>();
    #[cfg(feature = "spot-ws")]
    is::<spot::ws::InvalidStreamName>();
};

// Every product implements its class's bundle; one that drops a defining
// capability fails the build here.
#[cfg(feature = "usdm")]
const _: fn() = || {
    fn bundle<T: polyoxide_venue::PerpetualMarket>() {}
    bundle::<usdm::Usdm>();
};

#[cfg(feature = "spot")]
const _: fn() = || {
    fn bundle<T: polyoxide_venue::SpotMarket>() {}
    bundle::<spot::Spot>();
};