Struct Questions 

pub struct Questions { /* private fields */ }

The named questions of one request.

All questions see the same state and are answered independently and in parallel, so ask every question about a state in one request, including speculative ones.

use typesafe_client::{NoulQuestion, Questions, ScoreQuestion};

let mut questions = Questions::new();
let refund = questions.add("refund_requested", NoulQuestion::new("Is the user asking for a refund?"));
let anger = questions.add("frustration", ScoreQuestion::new("How frustrated is the user?", ["Calm", "Frustrated", "Very angry"]));

assert_eq!(questions.len(), 2);
assert_eq!(refund.id(), "refund_requested");

Implementations

impl Questions

pub fn new() -> Self

An empty set of questions.

pub fn add<Q: IntoQuestion>( &mut self, id: impl Into<String>, question: Q, ) -> QuestionKey<Q::Answer>

Adds question under id and returns a key that reads its answer with the matching type.

The id is only used to match answers to questions; it is not sent to the model, so the question itself must carry its full meaning. Ids must be unique: adding a second question with the same id replaces the first, and Questions::validate reports the duplicate.

pub fn get(&self, id: &str) -> Option<&Question>

The question with id.

pub fn iter(&self) -> Iter<'_, String, Question>

Questions with their ids, in the order they were added.

pub fn len(&self) -> usize

Number of questions.

pub fn is_empty(&self) -> bool

Whether there are no questions.

pub fn validate(&self) -> Result<(), ValidationError>

Checks the documented limits: at least one question, unique ids, 1 to 255 Choice options, and 2 to 10 Score levels.

Trait Implementations

impl Clone for Questions

fn clone(&self) -> Questions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Questions

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

Formats the value using the given formatter.

impl Default for Questions

fn default() -> Questions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Questions

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a Questions

type Item = (&'a String, &'a Question)

The type of the elements being iterated over.

type IntoIter = Iter<'a, String, Question>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Questions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Questions

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Questions