Struct Interaction

pub struct Interaction {
    pub kind: InteractionKind,
    pub prompt: String,
    pub out: Option<String>,
    pub options: Option<Vec<String>>,
}

Interaction models an interactive session with a user declaratively You can pick from confirm, input, and other modes of prompting.

Fields

kind: InteractionKind

type of interaction

prompt: String

what to ask the user

out: Option<String>

if set, capture the value of answer, and set it to a variable name defined here

options: Option<Vec<String>>

define the set of options just for kind=select

Implementations

impl Interaction

pub fn play( &self, varbag: Option<&mut VarBag>, events: Option<&mut TestEvents<IntoIter<KeyEvent>>>, ) -> Result<Response>

Play an interaction

Errors

This function will return an error if text input failed

pub fn to_question(&self) -> Question<'_>

Convert the interaction into a question

Trait Implementations

impl Clone for Interaction

fn clone(&self) -> Interaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Interaction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Interaction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.