Struct Choice 

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

A question that picks one of a set of named options.

An option without a description is interpreted by its name alone and is sent as null. Options are sent in the order they were first given; naming an option again replaces its description but keeps its position, which is what the upstream SDK’s dictionary does.

use typesafe_sdk::question::Choice;

let tone = Choice::new(["calm", "angry"])
    .option("calm", "neutral or polite")
    .instructions("What is the tone?");

Implementations

impl<'a> Choice<'a>

pub fn new<I>(options: I) -> Self

where I: IntoIterator, I::Item: Into<Cow<'a, str>>,

A choice between options, none of them described yet.

No option count is enforced here: the API documents its limits as subject to change, so the server is the one to judge them.

pub fn option( self, name: impl Into<Cow<'a, str>>, description: impl Into<Content<'a>>, ) -> Self

Adds the option name with a description, or describes it if it is already there.

pub fn instructions(self, instructions: impl Into<Content<'a>>) -> Self

What the model should decide when choosing. Setting it again replaces it.

Trait Implementations

impl<'a> Clone for Choice<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Choice<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Choice<'a>

impl<'a> From<Choice<'a>> for Question<'a>

fn from(question: Choice<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Choice<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Choice<'a>