bothan_htx/api.rs
1//! HTX WebSocket API client implementation.
2//!
3//! This module provides types and utilities for interacting with the HTX WebSocket API,
4//! including configuration, connection management, error handling, and message processing.
5//!
6//! The module provides:
7//!
8//! - [`error`] — Custom error types used during WebSocket client configuration and message processing.
9//! - [`types`] — Message types used for communication with the HTX WebSocket API.
10//! - [`websocket`] — WebSocket client implementation for real-time data streaming.
11//!
12//! # Integration with Workers
13//!
14//! This module is intended to be used by worker implementations that subscribe to HTX WebSocket streams for real-time updates.
15//! The WebSocket client can be used for streaming market data, such as ticker updates and price changes.
16//!
17//! The module exports [`WebSocketConnection`] and [`WebSocketConnector`] for WebSocket-based communication.
18
19pub use websocket::{WebSocketConnection, WebSocketConnector};
20
21pub mod error;
22pub mod types;
23pub mod websocket;