Struct Given 

pub struct Given<'a> { /* private fields */ }

The options a pass (or a TextForm) is made from, after its declaration let them through (PassSpec::check). Reading a key the declaration does not have, or reading it as what it is not declared as, is a bug in the pass: a panic.

Implementations

impl<'a> Given<'a>

pub fn required(&self, key: &str) -> &'a str

A required option’s value: always there.

pub fn optional(&self, key: &str) -> Option<&'a str>

An optional option’s value, or a one-of option’s, if given.

pub fn choice<T: Choice>(&self, key: &str) -> T

A required choice’s value.

pub fn optional_choice<T: Choice>(&self, key: &str) -> Option<T>

An optional choice’s value, if given.

Trait Implementations

impl<'a> Debug for Given<'a>

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

Formats the value using the given formatter.