atelier-connect — API reference¶
Skeleton API reference for crate
atelier-connect at
version 0.0.10.
Preliminary skeleton
Hand-derived from the Phase-1 survey. Run
make sdk-api SDK_PATH=../atelier-sdk before cutover to refresh
from rustdoc JSON.
Modules¶
| Module | Public items |
|---|---|
clients |
WssClient<D>, WssClientBuilder, HttpClient, ConnectionManager, ReconnectPolicy, DisconnectReason, HealthMonitor, plus more |
sources |
BinanceWssClient, BybitWssClient, CoinbaseWssClient, KrakenWssClient, ExchangeEvent |
config |
DataWorkerConfig, MarketWorkerConfig, plus nested sub-tables |
synchronizers |
EventSynchronizer, MarketSynchronizer, ClockMode |
workers |
DataWorker, MarketWorker, OutputSinkSet, TopicRegistry, IngestionCore, GapDetector, GapDetectorSet, plus more |
errors |
Connection / parse / worker-specific error enums |
remote_agent (feature: gateway) |
GatewayConnection, RemoteAgent, TelemetryReporter, UpstreamSink |
Quick links to high-traffic items¶
| Item | What it is | docs.rs |
|---|---|---|
BybitWssClient |
Bybit WebSocket client (perpetuals + spot) | link |
BinanceWssClient |
Binance WebSocket + REST client | link |
CoinbaseWssClient |
Coinbase Advanced Trade WebSocket client | link |
KrakenWssClient |
Kraken v2 WebSocket client | link |
ExchangeEvent |
Unified enum across exchange-native event types | link |
DataWorker |
Raw event passthrough worker | link |
MarketWorker |
Synchronized snapshot worker | link |
OutputSinkSet |
Fan-out container: channel + terminal + parquet sinks | link |
ConnectionManager |
Multi-exchange connection lifecycle tracker | link |
ReconnectPolicy |
Jittered exponential backoff with circuit breaker | link |
MarketWorkerManifest |
TOML-driven manifest parser, returns N MarketWorkerConfigs |
link |
Full reference (docs.rs): https://docs.rs/atelier-connect/latest/atelier_connect/