Struct Suite 

pub struct Suite {
    pub name: String,
    pub items: Vec<EvalItem>,
}

A set of items with a name.

Fields

name: String

What the suite is called, in reports and baselines.

items: Vec<EvalItem>

The items, in the order they run.

Implementations

impl Suite

pub fn new( name: impl Into<String>, items: Vec<EvalItem>, ) -> Result<Self, CorpusError>

Builds a suite, validating every item and refusing duplicate identifiers.

Errors

• CorpusError::Invalid from any item’s own validation;
• CorpusError::DuplicateId when two items share an identifier, which would make a report join two different measurements.

pub fn with_provenance( name: impl Into<String>, items: Vec<EvalItem>, provenance: Provenance, ) -> Result<Self, CorpusError>

Suite::new, with a blanket Provenance folded into every item that has the part.

Each item is validated with the declaration it wrote before the blanket is folded in, so a typo in a file is still an error naming that file’s field, and the blanket is never one. An item that declared a part itself keeps its own answer; the blanket only fills in the parts the item left authored.

Errors

Whatever Suite::new raises.

pub fn load_item(path: impl AsRef<Path>) -> Result<EvalItem, CorpusError>

Loads one item from a .toml or .json file.

Errors

• CorpusError::Read when the file cannot be read;
• CorpusError::UnknownFormat when the extension is neither;
• CorpusError::Parse when the document is malformed or carries a key this crate does not understand;
• CorpusError::Invalid when the item parses but cannot mean anything.

pub fn load_manifest( dir: impl AsRef<Path>, ) -> Result<SuiteManifest, CorpusError>

Loads the SuiteManifest of a directory, if it has one.

The manifest is suite.toml or suite.json beside the items. A directory without one has no blanket declaration, which is the ordinary case.

Errors

• CorpusError::Read when the file exists and cannot be read;
• CorpusError::Parse when it is not a manifest, including when it names a part this crate does not know.

pub fn load_dir( name: impl Into<String>, dir: impl AsRef<Path>, ) -> Result<Self, CorpusError>

Loads every .toml and .json item in a directory, in file-name order, with the directory’s SuiteManifest applied.

A suite.toml or suite.json in the directory is the manifest, not an item.

Errors

• CorpusError::Read when the directory or one of its files cannot be read;
• whatever Suite::load_manifest, Suite::load_item and Suite::with_provenance raise.

pub fn select(&self, selection: &SelectionConfig) -> Vec<&EvalItem>

The items a selection runs, in suite order.

pub fn get(&self, id: &ItemId) -> Option<&EvalItem>

One item by identifier.

pub fn tags(&self) -> Vec<Tag>

Every tag used in the suite, sorted and deduplicated.

Trait Implementations

impl Clone for Suite

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 Suite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Suite

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Suite

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Suite

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 Suite