o2_sdk/
guides.rs

1//! Integration guides for the O2 Rust SDK.
2//!
3//! These guides cover common patterns and workflows for trading on the
4//! O2 Exchange. Each sub-module contains a standalone guide rendered from
5//! Markdown.
6//!
7//! # Available Guides
8//!
9//! | Guide | Description |
10//! |-------|-------------|
11//! | [`trading`] | Order types, cancel/replace, batch actions, and market maker patterns |
12//! | [`market_data`] | Fetching depth, trades, candles, tickers, and balances |
13//! | [`websocket_streams`] | Real-time data with [`TypedStream`](crate::TypedStream) and reconnection handling |
14//! | [`error_handling`] | Error types, recovery patterns, and robust trading loops |
15//! | [`external_signers`] | Integrating KMS/HSM via the [`SignableWallet`](crate::SignableWallet) trait |
16
17#[doc = include_str!("../docs/guides/trading.md")]
18pub mod trading {}
19
20#[doc = include_str!("../docs/guides/market-data.md")]
21pub mod market_data {}
22
23#[doc = include_str!("../docs/guides/websocket-streams.md")]
24pub mod websocket_streams {}
25
26#[doc = include_str!("../docs/guides/error-handling.md")]
27pub mod error_handling {}
28
29#[doc = include_str!("../docs/guides/external-signers.md")]
30pub mod external_signers {}
o2_sdk/guides.rs

o2_sdk/
guides.rs
