atelier-types — API reference

Skeleton API reference for crate atelier-types at version 0.0.10. Every public item links out to docs.rs for full signatures, source, and trait implementations.

Preliminary skeleton

The tables below were hand-derived from a survey of the SDK source. Before cutover, regenerate authoritatively with:

make sdk-api SDK_PATH=../atelier-sdk

That populates per-module sub-pages and refreshes this index from rustdoc JSON. See Cutover runbook.

Modules

Module	Public items
config	MarketSnapshotConfig, MarketConfig, WorkerManifest
errors	OrderError, OrderbookError, PersistError, TemporalError, ConfigError, plus 2 more
exchanges	Exchange, MarketType
funding	FundingRate
levels	Level
liquidations	Liquidation
open_interest	OpenInterest
orderbooks	Orderbook, OrderbookDelta, NormalizedDelta
orders	Order, OrderSide, OrderType
snapshots	MarketSnapshot, MarketAggregate
subscriptions	SubscriptionStatus
synchronizers	ClockMode, WorkerMode (the MarketSynchronizer / EventSynchronizer types live in atelier-connect)
temporal	TimeResolution, validation helpers, from_nanos
trades	Trade, TradeSide
trading_pair	TradingPair
workers	WorkerId
templates	internal templates; surface intentionally undocumented
utils	utility helpers; mostly private

Quick links to high-traffic items

Item	What it is	docs.rs
Orderbook	BTreeMap-backed limit order book	link
OrderbookDelta	Incremental order book update	link
Trade	Public trade execution	link
TradeSide	Buy / sell taker side	link
MarketSnapshot	Multi-source time-aligned bundle	link
MarketAggregate	15-scalar feature vector from a snapshot	link
ClockMode	OrderbookDriven / TradeDriven / LiquidationDriven / External	link
WorkerMode	Raw / Clock — user-visible worker mode badge	link
Exchange	Bybit / Binance / Coinbase / Kraken	link
WorkerManifest	TOML-driven multi-worker config	link

Full reference (docs.rs): https://docs.rs/atelier-types/latest/atelier_types/