Struct Contract 

pub struct Contract {
    pub format_version: u32,
    pub name: String,
    pub rounds: usize,
    pub cluster: Cluster,
    pub kafka_image: String,
    pub cells: Vec<Cell>,
    pub budgets: BTreeMap<Metric, Budget>,
    pub modes: BTreeMap<Mode, ModePolicy>,
}

The whole regression contract.

Fields

format_version: u32

Must be FORMAT_VERSION.

name: String

The contract’s name, which every record and report carries.

rounds: usize

Interleaved rounds; each round runs every cell once per side.

cluster: Cluster

The cluster every trial runs against.

kafka_image: String

The pinned Kafka image a Mode::PinnedKafka comparison runs, and whose client jars drive both sides in every mode.

cells: Vec<Cell>

The workload matrix.

budgets: BTreeMap<Metric, Budget>

One budget per budgeted metric.

modes: BTreeMap<Mode, ModePolicy>

What each mode gates on.

Implementations

impl Contract

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

Parse and validate a contract from its JSON bytes.

Errors

Returns BudgetError when the bytes are not a contract or the contract fails Contract::validate.

pub fn validate(&self) -> Result<(), BudgetError>

Check that the contract can judge a comparison.

Errors

Returns BudgetError::InvalidContract naming the first problem.

pub fn cell(&self, id: &str) -> Option<&Cell>

The cell with this id.

Trait Implementations

impl Clone for Contract

fn clone(&self) -> Contract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Contract

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Contract

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Contract

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Contract

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 Contract