Struct Options 

pub struct Options { /* private fields */ }

Everything a run needs besides the description itself.

Built by chaining: Options::new().workflow("buyPet").input("petId", 7).

Implementations

impl Options

pub fn new() -> Self

Options with nothing set: the first workflow, no inputs, no source documents.

pub fn workflow(self, workflow_id: impl Into<String>) -> Self

Run this workflow rather than the description’s first.

pub fn input(self, name: impl Into<String>, value: impl Into<Value>) -> Self

Set one workflow input.

pub fn inputs(self, inputs: Value) -> Self

Set every input at once, from a JSON object.

pub fn source( self, name: impl Into<String>, url: impl Into<String>, document: Value, ) -> Self

Supply a source description: the name it was declared with, the url it was declared with, and the parsed document.

Fetching documents is IO, which this crate leaves to its caller — roas-file-fetcher and roas-http-fetcher do it for the loader and do it here just as well.

pub fn base_url( self, source_name: impl Into<String>, url: impl Into<String>, ) -> Self

Send this source description’s requests somewhere else — a test server, a staging host — whatever its document says.

pub fn header(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add a header to every request a step does not set itself.

pub fn max_steps(self, steps: usize) -> Self

The most steps a run may take before it is called a loop.

pub fn max_depth(self, depth: usize) -> Self

The deepest a workflow may call another.

pub fn max_retries(self, retries: u32) -> Self

The most times one step may be retried.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.