Struct PassSpec 

pub struct PassSpec {
    pub name: &'static str,
    pub options: &'static [OptionSpec],
    pub make: fn(&Given<'_>) -> Result<Box<dyn Pass>, String>,
}

A pass as the registry knows it: its name, the options it takes, and how it is made from what the declaration let through.

Fields

name: &'static str

options: &'static [OptionSpec]

make: fn(&Given<'_>) -> Result<Box<dyn Pass>, String>

Implementations

impl PassSpec

pub fn requires_options(&self) -> bool

Whether a pipeline must give it options: a required option or a one-of group.

pub fn example(&self) -> Options

The options it is made with to read its declarations: each required option’s example and the first option’s of each group.

pub fn check(&self, options: &Options) -> Result<(), String>

options against the declaration: the refusal of the first undeclared key, missing required option, one-of group given none or more than one of, or choice value outside its values.

pub fn instance(&self, options: &Options) -> Result<Box<dyn Pass>, String>

The pass made from options, once PassSpec::check lets them through.

pub fn describe(&self) -> String

Its text form and what each option means: translate-world{by*} (* a required option, | between the options of a group), then a line per option, an optional one’s ending with what its absence means.

Trait Implementations

impl Debug for PassSpec

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

Formats the value using the given formatter.