atelier-io — API reference¶
Skeleton API reference for crate
atelier-io 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.
Modules¶
| Module | Public items |
|---|---|
orderbooks |
write_ob_parquet, read_ob_parquet, plus CSV/JSON readers/writers |
trades |
write_trades_parquet_timestamped, read_trades_parquet |
funding |
write_funding_parquet_timestamped, read_funding_parquet |
liquidations |
write_liquidations_parquet_timestamped, read_liquidations_parquet |
open_interest |
write_oi_parquet_timestamped, read_oi_parquet |
snapshots |
Aggregate snapshot I/O |
flush (features: connect + parquet) |
FlushToParquet, FlushObSyncToParquet, FlushAggregateToParquet |
sink (feature: connect) |
ParquetSnapshotFlusher |
Quick links¶
| Item | docs.rs |
|---|---|
FlushToParquet |
link |
FlushObSyncToParquet |
link |
FlushAggregateToParquet |
link |
ParquetSnapshotFlusher |
link |
read_ob_parquet |
link |
read_trades_parquet |
link |
write_trades_parquet_timestamped |
link |
Full reference (docs.rs): https://docs.rs/atelier-io/latest/atelier_io/