Module subplotlib::prelude

The subplotlib prelude.

This prelude is automatically imported into all generated subplot test suites using the rust template. Effectively they get

use subplotlib::prelude::*;

inserted into them at the top of the file.

You should familiarise yourself with the context-related types if you are writing your own contexts, or writing step functions which use the contexts provided by the step library itself.

The primary thing you will need to learn, as a step function author, is the #[step] attribute macro, and it interacts with contexts.

Macros

• throw
  Throw an error.

Structs

• Scenario
  The embodiment of a subplot scenario
• ScenarioContext
  A container for all scenario contexts
• ScenarioStep
  A ScenarioStep is one step in a scenario.
• SubplotDataFile
  An embedded data file.

Traits

• ContextElement
  A context element is anything which can be used as a scenario step context.

Functions

• base64_decode
  Decode a base64 string.

Type Aliases

• StepError
  Generic error type which steps can return.
• StepResult
  Result type using StepError.

Attribute Macros

• step
  Mark a function as a Subplot step function.
• throws
  Indicate what type a function throws