Struct RunExternalOptions 

pub struct RunExternalOptions {
    pub bot_id: Option<String>,
    pub env: Option<EnvName>,
    pub url: Option<String>,
    pub token: Option<String>,
    pub config: Option<ChipzenConfig>,
    pub retry_policy: Option<RetryPolicy>,
    pub client_name: Option<String>,
    pub client_version: Option<String>,
    pub safe_mode: Option<bool>,
    pub max_matches: Option<u64>,
    pub user_agent: Option<String>,
}

Options for run_external_bot. Mirrors the Python kwargs.

Fields

bot_id: Option<String>

External-API bot UUID. Used to build the lobby URL when url is not given; falls back to [external_api].bot_id in chipzen.toml.

env: Option<EnvName>

Target environment. None consults $CHIPZEN_ENV then defaults to prod.

url: Option<String>

Explicit full lobby URL (wss://.../ws/external/bot/{bot_id}). Overrides bot_id / env URL derivation when set.

token: Option<String>

Long-lived cz_extbot_ API token. Falls back to [external_api].token in chipzen.toml. Required.

config: Option<ChipzenConfig>

Pre-loaded config, to avoid a second filesystem stat.

retry_policy: Option<RetryPolicy>

Reconnect-pacing policy for both lobby drops and mid-match gateway drops. None uses RetryPolicy::default.

client_name: Option<String>

Sent in the per-match hello handshake. Defaults to chipzen-sdk-rust.

client_version: Option<String>

Sent in the per-match hello handshake. Defaults to the crate version.

safe_mode: Option<bool>

When true (default), a panic in decide() is folded; false propagates it as a terminal Error::BotDecision.

max_matches: Option<u64>

Stop after this many matches complete. None runs until the lobby closes / the bot is evicted. Some(1) plays a single challenge.

user_agent: Option<String>

Override the WS User-Agent. Defaults to chipzen-sdk-rust/<version>.

Trait Implementations

impl Clone for RunExternalOptions

fn clone(&self) -> RunExternalOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunExternalOptions

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

Formats the value using the given formatter.

impl Default for RunExternalOptions

fn default() -> RunExternalOptions

Returns the “default value” for a type.