Struct Declaration 

pub struct Declaration {

    pub arena_id: String,
    pub arena_version: String,
    pub changelog: Vec<ChangelogEntry>,
    pub payload_schema_version: u32,
    pub entrants: Entrants,
    pub inputs: Vec<ValueDecl>,
    pub outputs: Vec<ValueDecl>,
    pub no_action: String,
    pub control_rate: u32,
    pub budgets: Budgets,
    pub max_turns: u32,
    pub wire: WireSizes,
    pub stats: Vec<StatDecl>,
    pub series: Vec<SeriesDecl>,
    pub events: Vec<EventDecl>,
    pub shaping_reward: String,
    pub min_trainer_version: String,
}

Fields

arena_id: String

The arena’s slug, e.g. boxing. With the payload schema version, it names the ladder.

arena_version: String

Semver. Bumped with every engine change.

changelog: Vec<ChangelogEntry>

What changed in each version, newest first.

payload_schema_version: u32

Bumped when inputs or outputs change. A new schema starts a new ladder.

entrants: Entrants

inputs: Vec<ValueDecl>

Every observation value, in payload order.

outputs: Vec<ValueDecl>

Every action value, in payload order. Their bounds are the only validity check on an output.

no_action: String

What a seat does with no valid action, in plain words. The engine implements it; it’s never inferred from the bounds.

control_rate: u32

Turns per second.

budgets: Budgets

max_turns: u32

Reaching it ends the session with a real result.

wire: WireSizes

stats: Vec<StatDecl>

series: Vec<SeriesDecl>

events: Vec<EventDecl>

shaping_reward: String

The training-only shaping reward, in words. It never affects scoring.

min_trainer_version: String

The oldest botstadia-train that can train on this version.

Implementations

impl Declaration

pub fn to_json(&self) -> Vec<u8>

pub fn from_json(bytes: &[u8]) -> Result<Self, Error>

pub fn stat_index(&self, key: &str) -> Option<usize>

pub fn series_index(&self, key: &str) -> Option<usize>

pub fn event_index(&self, key: &str) -> Option<usize>

pub fn input_payload_bytes(&self) -> usize

The largest input payload the declaration allows.

pub fn output_payload_bytes(&self) -> usize

The largest output payload the declaration allows.

pub fn problems(&self) -> Vec<Problem>

Everything wrong with this declaration. Empty means it’s complete.

Trait Implementations

impl Clone for Declaration

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Declaration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Declaration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Declaration

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Declaration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Declaration