Enum Question 

#[non_exhaustive]
pub enum Question {
    #[non_exhaustive]
    Noul {
        instructions: Value,
        criteria: Option<NoulCriteria>,
    },
    #[non_exhaustive]
    Choice {
        instructions: Value,
        criteria: BTreeMap<String, Option<String>>,
    },
    #[non_exhaustive]
    Score {
        instructions: Value,
        criteria: Vec<String>,
    },
}

A typed question evaluated against the request state.

instructions may be a string, object or array. Reference nested state with backticked paths such as `rows[3].country`. Construct through the associated functions (Question::noul, Question::choice, Question::score) or the SystemOneRequest builder; the variants are #[non_exhaustive] so fields can follow the API without breaking callers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

#[non_exhaustive]

Noul

Yes/no. Answered with the probability of “yes”.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

instructions: Value

The question, referring to the state.

criteria: Option<NoulCriteria>

What yes and no mean, when spelled out.

#[non_exhaustive]

Choice

One option out of a defined set (at most MAX_CHOICE_OPTIONS). Answered with the chosen option and the probability of every option.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

instructions: Value

The question, referring to the state.

criteria: BTreeMap<String, Option<String>>

Option → optional rubric description.

#[non_exhaustive]

Score

A position along an ordered rubric of at least two levels.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

instructions: Value

The question, referring to the state.

criteria: Vec<String>

Level descriptions, lowest first.

Implementations

impl Question

pub fn noul(instructions: impl Into<Value>) -> Self

A yes/no question without criteria descriptions.

pub fn noul_with_criteria( instructions: impl Into<Value>, yes: impl Into<String>, no: impl Into<String>, ) -> Self

A yes/no question with descriptions of what yes and no mean.

pub fn choice<K, V>( instructions: impl Into<Value>, options: impl IntoIterator<Item = (K, Option<V>)>, ) -> Self

where K: Into<String>, V: Into<String>,

Pick one of options. Each option is (name, optional description).

pub fn choice_plain<K: Into<String>>( instructions: impl Into<Value>, options: impl IntoIterator<Item = K>, ) -> Self

Pick one of options, none of which carries a description.

pub fn score<L: Into<String>>( instructions: impl Into<Value>, levels: impl IntoIterator<Item = L>, ) -> Self

Rate along levels, ordered from lowest to highest.

Trait Implementations

impl Clone for Question

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Question

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

Formats the value using the given formatter.

impl PartialEq for Question

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Question

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Question