Enum Prompt 

#[non_exhaustive]
pub enum Prompt {
    Confirm {
        question: String,
        default: Option<bool>,
    },
    Text {
        label: String,
        validator: ValidatorSpec,
    },
    Secret {
        label: String,
        validator: ValidatorSpec,
    },
    Literal {
        label: String,
        expected: String,
    },
    Continue {
        hint: Option<String>,
    },
    Reveal {
        label: String,
        note: Option<String>,
        shown: Shown,
    },
    EnterRows {
        label: String,
        note: Option<String>,
        format: RevealFormat,
        rows: Option<usize>,
        validator: Option<ValidatorSpec>,
    },
}

Request for user input, recorded into the transcript as part of StepFact::PromptAnswered.

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.

Confirm

Yes / no question with an optional default.

Fields

question: String

Question shown to the user.

default: Option<bool>

Default selection if the user presses Enter without choosing.

Text

Free-form text input, validated against a ValidatorSpec.

Fields

label: String

Label shown to the user.

validator: ValidatorSpec

Validator applied before the response is accepted.

Secret

Sensitive input (PIN, password). Echo is suppressed; plaintext is never serialized to the transcript.

Fields

label: String

Label shown to the user.

validator: ValidatorSpec

Validator applied before the response is accepted.

Literal

User must type a specific literal string exactly. Validation is performed by the runtime against expected.

Fields

label: String

Label shown to the user.

expected: String

Exact string the user must type.

Continue

Wait for the user to acknowledge before proceeding. Used for pacing.

Fields

hint: Option<String>

Optional hint such as “Press Enter when ready”.

Reveal

Show a value while the prompt is up, and withdraw it when the person acknowledges. What was shown is never recorded: the transcript carries the label and the acknowledgement.

Fields

label: String

What the value is and what to do with it, shown above it.

note: Option<String>

The step’s note:, the same text the sheet carries.

shown: Shown

The value, laid out for writing down. Skipped when the prompt is written to the transcript, and empty when one is read back.

EnterRows

Rows of a value a person types from a sheet, one at a time, each checked as it is entered. The answer is a secret: the transcript carries the label and that an answer was given, never the rows.

Fields

label: String

What the value is, shown above the rows.

note: Option<String>

The step’s note:.

format: RevealFormat

The encoding the sheet was written in.

rows: Option<usize>

Rows expected, when the step knows the value’s length; without it a short row, or an empty row after full ones, ends the entry.

validator: Option<ValidatorSpec>

The rule the rows as a whole must satisfy, which the runtime checks and a rehearsal can build a stand-in for. None when the step checks the value itself, as for a share, which no made-up value is.

Implementations

impl Prompt

pub fn for_record(&self) -> Self

The prompt as the transcript records it: the same, except that a value shown for writing down is left out, so no copy of it travels with the fact.

Trait Implementations

impl Clone for Prompt

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 Prompt

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Prompt

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Prompt

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

where __S: Serializer,

Serialize this value into the given Serde serializer.