Skip to content

API 文档

AXON 的完整 Rust API 文档由 cargo doc 自动生成并发布到 docs.rs:

本地生成

cargo doc --workspace --no-deps --open

输出在 target/doc/ 目录。

关键类型速查

axon-core

  • Order / OrderId / OrderSide / OrderType / TimeInForce
  • MarketData / Tick / Bar / OrderBook
  • Event / EventQueue / SimulatedClock
  • Portfolio / Position / Cash
  • Scheduler / ImpactModel / LatencyModel / FeeModel

axon-backtest

  • L1MatchingEngine / L2MatchingEngine / L3MatchingEngine
  • BacktestConfig / BacktestResult

axon-rl

  • AxonEnv(Gymnasium 兼容)
  • VecEnv(向量化环境)
  • Step / Reset / Action / Observation

axon-llm

  • ReActAgent / Tool trait
  • LLMBackend / OpenAICompatBackend / MockLLMBackend
  • trading::PlaceOrderTool / QueryPortfolioTool / CancelOrderTool / ReplaceOrderTool
  • trading::TradingBackend trait
  • trading::RiskLimits / SafetyMode / RiskGate
  • trading::TradingMetrics