Struct QuestionItem 

pub struct QuestionItem {
    pub question: String,
    pub header: Option<String>,
    pub options: Option<Vec<QuestionOption>>,
    pub multi_select: bool,
    pub purpose: Option<String>,
    pub required: bool,
    pub question_type: QuestionType,
    pub id: String,
    pub recommended: Option<String>,
}

A single question to ask the user.

Wire format — the industry-standard shape used by Claude Code’s AskUserQuestion and its ports (Qwen Code, OpenCode, Crush):

{"question": "...", "header": "...",
 "options": [{"label": "...", "description": "..."}], "multiSelect": false}

The kind is derived, never declared: multiSelect selects the multi kind, any non-empty options the single kind, absence of options the free-text kind. question_type and id are internal (serialized for the TUI and answer correlation, excluded from the model-facing schema).

Fields

question: String

The complete question text displayed to the user. Clear, specific, ends with a question mark.

header: Option<String>

Very short label displayed as a chip/tag (max 12 chars). Examples: “Auth method”, “Library”, “Approach”.

options: Option<Vec<QuestionOption>>

The available choices for this question (2-4 options). Omit for a free-text question. Do NOT add an “Other” option — free text is always offered automatically.

multi_select: bool

Set to true to allow the user to select multiple options instead of just one. Defaults to false.

purpose: Option<String>

Why the agent needs this information. Helps the user understand the context and give better answers.

required: bool

Whether an answer is required. Defaults to true.

question_type: QuestionType

Internal: derived kind, per the struct doc. Never part of the schema.

id: String

Internal: stable identifier used to correlate answers. Derived from position when absent. Never part of the schema.

recommended: Option<String>

Internal: label of the recommended single-select option (marked via RECOMMENDED_SUFFIX, moved to the top by the tool). Never part of the schema.

Implementations

impl QuestionItem

pub fn text(question: impl Into<String>) -> Self

Free-text constructor (no options).

pub fn single_choice(question: impl Into<String>, labels: &[&str]) -> Self

Single-select constructor from plain labels.

pub fn multi_choice(question: impl Into<String>, labels: &[&str]) -> Self

Multi-select constructor from plain labels.

Trait Implementations

impl Clone for QuestionItem

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 QuestionItem

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

Formats the value using the given formatter.

impl Default for QuestionItem

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QuestionItem

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for QuestionItem

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for QuestionItem

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

where __S: Serializer,

Serialize this value into the given Serde serializer.