Struct ChoiceQuestion 

#[non_exhaustive]
pub struct ChoiceQuestion {
    pub instructions: Option<Content>,
    pub criteria: IndexMap<String, Option<Content>>,
}

Picks one option from a set you define.

Options keep the order they were added in. Adding an option with a name that already exists replaces its description. For options that map to a Rust enum, prefer EnumChoice.

use typesafe_client::ChoiceQuestion;

let question = ChoiceQuestion::new("Which team should handle this?")
    .with_option("billing", "Payments, invoicing, refunds")
    .with_option("technical", "Bugs, outages, integrations")
    .with_bare_option("sales");
assert_eq!(question.criteria.len(), 3);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instructions: Option<Content>

What the model should decide.

criteria: IndexMap<String, Option<Content>>

Option name to description; None is sent as null (the name speaks for itself).

Implementations

impl ChoiceQuestion

pub fn new(instructions: impl Into<Content>) -> Self

A Choice asking instructions, with no options yet.

pub fn with_option( self, name: impl Into<String>, description: impl Into<Content>, ) -> Self

Adds an option with a description of when it applies.

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

Adds an option without a description, for names that are self-explanatory or whose meaning lives in the state (for example line or element ids).

pub fn with_bare_options<I>(self, names: I) -> Self

where I: IntoIterator, I::Item: Into<String>,

Adds several options without descriptions.

Trait Implementations

impl Clone for ChoiceQuestion

fn clone(&self) -> ChoiceQuestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChoiceQuestion

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

Formats the value using the given formatter.

impl Default for ChoiceQuestion

fn default() -> ChoiceQuestion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChoiceQuestion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ChoiceQuestion> for Question

fn from(question: ChoiceQuestion) -> Self

Converts to this type from the input type.

impl IntoQuestion for ChoiceQuestion

type Answer = ChoiceAnswer

How the answer is read; the type parameter of the returned QuestionKey.

fn into_question(self) -> Question

The question as sent on the wire.

impl PartialEq for ChoiceQuestion

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChoiceQuestion

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 ChoiceQuestion