Struct Prompt 

pub struct Prompt {
    pub key: String,
    pub prompt: String,
    pub input_type: InputType,
    pub options: Vec<SelectOption>,
    pub required: bool,
}

A single data request - tells the client exactly one thing to collect.

Fields

key: String

The bag key this prompt populates.

prompt: String

Human-readable question or instruction.

input_type: InputType

What kind of input widget the client should render.

options: Vec<SelectOption>

Options for SelectOne or SelectMany input types.

required: bool

Whether the user must provide a value.

Implementations

impl Prompt

pub fn select_one( key: impl Into<String>, prompt: impl Into<String>, options: Vec<SelectOption>, ) -> Self

Create a SelectOne prompt.

pub fn secret(key: impl Into<String>, prompt: impl Into<String>) -> Self

Create a Secret prompt (masked input).

pub fn secret_confirm(key: impl Into<String>, prompt: impl Into<String>) -> Self

Create a SecretConfirm prompt (passphrase + confirmation).

pub fn code(key: impl Into<String>, prompt: impl Into<String>) -> Self

Create a Code prompt (short verification code).

pub fn text(key: impl Into<String>, prompt: impl Into<String>) -> Self

Create a Text prompt (free text).

pub fn entropy(key: impl Into<String>, prompt: impl Into<String>) -> Self

Create an Entropy prompt.

pub fn fido2(key: impl Into<String>, prompt: impl Into<String>) -> Self

Create a Fido2 prompt (WebAuthn hardware key interaction).

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

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.