Skip to main content

BotConfigBuilder

Struct BotConfigBuilder 

Source
pub struct BotConfigBuilder { /* private fields */ }
Expand description

Builder for BotConfig.

Implementations§

Source§

impl BotConfigBuilder

Source

pub fn name(self, name: impl Into<String>) -> Self

Human-readable bot name (logs, supervisor identification). Required.

Source

pub fn symbol(self, sym: impl Into<Symbol>) -> Self

Add a single symbol. Repeated calls accumulate.

Source

pub fn symbols<I, S>(self, syms: I) -> Self
where I: IntoIterator<Item = S>, S: Into<Symbol>,

Add many symbols at once. Repeated calls accumulate.

Source

pub fn shutdown_timeout(self, dur: Duration) -> Self

Maximum time to wait for services to drain on shutdown.

Source

pub fn without_signal_handler(self) -> Self

Disable the supervisor’s signal handler — host drives shutdown.

Source

pub fn market_bus_capacity(self, cap: usize) -> Self

Override the in-process market-data bus capacity (default 1024).

Source

pub fn signal_bus_capacity(self, cap: usize) -> Self

Override the in-process signal-bus capacity (default 256).

Source

pub fn close_positions_on_shutdown(self, b: bool) -> Self

Enable best-effort exchange.close_position for non-flat positions after the supervisor drains.

Source

pub fn session_pnl_config(self, cfg: SessionPnlConfig) -> Self

Override the session-PnL config used for every symbol.

Source

pub fn circuit_breaker_config(self, cfg: CircuitBreakerConfig) -> Self

Override the circuit-breaker config used for every symbol.

Source

pub fn sizing_config(self, cfg: SizingConfig) -> Self

Override the position-sizing config used for every symbol.

Source

pub fn portfolio_config(self, cfg: PortfolioRiskConfig) -> Self

Set the account-wide PortfolioRiskConfig — a daily-loss halt, a max-concurrent-positions cap, and a gross-exposure cap applied across all symbols. Unset, every limit is off (the per-symbol gates still apply).

use rustrade::{BotConfig, PortfolioRiskConfig};

let cfg = BotConfig::builder()
    .name("bot")
    .symbols(["BTCUSDT", "ETHUSDT"])
    .without_signal_handler()
    .portfolio_config(PortfolioRiskConfig {
        max_daily_loss: -500.0,
        max_concurrent_positions: 3,
        max_gross_exposure: 50_000.0,
    })
    .build()
    .unwrap();
assert_eq!(cfg.portfolio.max_concurrent_positions, 3);
Source

pub fn bracket_failure_policy(self, policy: BracketFailurePolicy) -> Self

Set the BracketFailurePolicy — what happens when a bracket entry fills but its protective stop-loss leg fails to place. Defaults to BracketFailurePolicy::CloseEntry.

Source

pub fn symbol_risk(self, symbol: impl Into<Symbol>, cfg: RiskConfig) -> Self

Set a per-symbol RiskConfig override. The given symbol then uses this config (session-PnL cap, circuit breaker, sizing) instead of the bot-wide default. Repeated calls for the same symbol replace the previous override. Symbols without an override use the default.

use rustrade::{BotConfig, RiskConfig};
use rustrade::SessionPnlConfig;

let cfg = BotConfig::builder()
    .name("bot")
    .symbols(["BTCUSDT", "DOGEUSDT"])
    .without_signal_handler()
    // tighter daily loss cap on the volatile alt
    .symbol_risk("DOGEUSDT", RiskConfig {
        session_pnl: SessionPnlConfig { loss_limit: -20.0 },
        ..Default::default()
    })
    .build()
    .unwrap();
assert_eq!(cfg.risk_for(&"DOGEUSDT".into()).session_pnl.loss_limit, -20.0);
Source

pub fn class_risk(self, class: AssetClass, cfg: RiskConfig) -> Self

Set a per-AssetClass RiskConfig override. Symbols whose instrument reports this class use cfg (unless a per-symbol override also exists, which wins). See RiskConfig::preset_for for ready-made presets to start from.

use rustrade::{AssetClass, BotConfig, RiskConfig};

let cfg = BotConfig::builder()
    .name("multi-asset")
    .symbols(["XBTUSDTM", "EURUSD"])
    .without_signal_handler()
    .class_risk(AssetClass::CryptoPerp, RiskConfig::crypto_perp())
    .class_risk(AssetClass::Fx, RiskConfig::fx())
    .build()
    .unwrap();
// FX symbols resolve to the FX preset (20× leverage) absent a
// per-symbol override.
assert_eq!(
    cfg.resolve_risk(&"EURUSD".into(), AssetClass::Fx).sizing.leverage,
    20
);
Source

pub fn build(self) -> Result<BotConfig>

Validate and build. Returns Error::Config on any constraint violation — the framework never panics on bad config.

Trait Implementations§

Source§

impl Clone for BotConfigBuilder

Source§

fn clone(&self) -> BotConfigBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BotConfigBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BotConfigBuilder

Source§

fn default() -> BotConfigBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more