Struct SpecFile 

pub struct SpecFile {
    pub model: String,
    pub set: BTreeMap<String, SpecValue>,
    pub run: RunTable,
    pub measure: MeasureTable,
    pub seeds: SeedsTable,
    pub actions: Vec<ActionTable>,
    pub blocks: Vec<BlockTable>,
    pub search: Option<SearchTable>,
    pub execution: ExecutionTable,
}

A sweep spec as written in a TOML file.

Fields

model: String

Id of the model to run.

set: BTreeMap<String, SpecValue>

Values every config shares, by parameter id.

run: RunTable

Length and end of each run, the [run] table.

measure: MeasureTable

Sampling cadence and reducers, the [measure] table.

seeds: SeedsTable

Root seed and seed scheme, the [seeds] table.

actions: Vec<ActionTable>

Actions every run fires, each an [[action]] table.

blocks: Vec<BlockTable>

Blocks in order, each a [[block]] table.

search: Option<SearchTable>

Search that picks the configs instead of blocks.

execution: ExecutionTable

Settings that spread the runs over the machine and never change a result.

Implementations

impl SpecFile

pub fn load(path: &Path) -> Result<(Self, String), SpecFileError>

Reads the spec file at path, and the design tables that its blocks refer to, and returns it with its text as written.

A table’s path is relative to the directory of path and cannot leave it. Only a table design’s file is read.

Errors

Returns SpecFileError::Read when the file or a table cannot be read, SpecFileError::TablePath for a table path that is absolute or holds a component other than a name, and the errors of Self::parse.

pub fn tables(&self) -> Vec<DesignTableFile>

Returns the design tables Self::load read, in block order.

pub fn parse(text: &str) -> Result<Self, SpecFileError>

Reads a spec file from its text.

Errors

Returns SpecFileError::Parse for text that is not TOML, or a key or value that no table accepts.

pub fn from_json(value: &Value) -> Result<Self, SpecFileError>

Reads a spec file from value, the JSON form a manifest records.

Errors

Returns SpecFileError::Json for a value that no table accepts.

pub fn to_toml(&self) -> Result<String, Error>

Returns the file as TOML text.

Errors

Returns the serializer’s error. Every field of a spec file has a TOML form, so no error is expected.

pub fn into_spec(self) -> Result<SweepSpec, SpecFileError>

Returns the sweep spec the file describes, leaving its execution settings behind.

Errors

Returns SpecFileError for a factor without exactly one target or one form of levels, block keys that do not fit the design, a table that was never read, a reducer kind, stop condition or timeout that cannot be read, or a [search] table beside blocks or with settings of a different algorithm. Everything else is checked when the spec is planned.

Trait Implementations

impl Clone for SpecFile

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 SpecFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpecFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SweepSpec> for SpecFile

fn from(spec: &SweepSpec) -> Self

Writes each value as SpecValue::from_text converts it, and each consecutive group of reducers over one column as one entry.

impl PartialEq for SpecFile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SpecFile

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 SpecFile