Struct Suite 

pub struct Suite {
    pub name: String,
    pub vocabulary: Vocabulary,
    pub background: Condition,
    pub background_steps: Vec<StepText>,
    pub sections: Vec<Section>,
    pub features: Vec<Feature>,
    pub expectations: Vec<Expectation>,
    pub stories: Vec<Story>,
    pub glossary: Vec<Term>,
    pub sources: Sources,
    pub platforms: Vec<String>,
    pub platform: Option<String>,
}

A whole suite: the vocabulary, its sections (the first is the root), and the expectations and stories written against them.

Fields

name: String

vocabulary: Vocabulary

background: Condition

The root section’s start, which every section builds on.

background_steps: Vec<StepText>

sections: Vec<Section>

features: Vec<Feature>

expectations: Vec<Expectation>

stories: Vec<Story>

glossary: Vec<Term>

Term:s: the glossary’s definitions.

sources: Sources

platforms: Vec<String>

Platform:s the suite is run on; the first is the default, which untagged lines are about.

platform: Option<String>

The platform this suite was read for (a lens on one platform’s variants), if the suite declares platforms.

Implementations

impl Suite

pub fn exp(&self, id: ExpId) -> &Expectation

pub fn feature(&self, id: FeatureId) -> &Feature

pub fn story(&self, id: StoryId) -> &Story

pub fn section(&self, id: SectionId) -> &Section

pub fn chain(&self, id: SectionId) -> Vec<&Section>

The root first, down to id.

pub fn section_of(&self, e: ExpId) -> &Section

The section an expectation belongs to (its feature’s).

pub fn subtree(&self, id: SectionId) -> Vec<SectionId>

id and every section below it.

pub fn describe(&self, c: &Condition) -> String

pub fn describe_trigger(&self, t: &Trigger) -> String

“the user presses reset”, “the dial is above 55 %”, or both.

pub fn transitions(&self) -> impl Iterator<Item = &Expectation>

Transitions (expectations with a trigger), in declaration order.

pub fn invariants(&self) -> impl Iterator<Item = &Expectation>

Trait Implementations

impl Clone for Suite

fn clone(&self) -> Suite

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 Default for Suite

fn default() -> Suite

Returns the “default value” for a type.