Enum inkling::Prompt

pub enum Prompt {
    Done,
    Choice(Vec<Choice>),
}

Result from following a Story.

Examples

let content = "\
Professor Lidenbrock had barely a spattering of water left in his flask.
*   Axel got the last of it.
*   He pressed on, desperately hoping to find water soon.
";

let mut story = read_story_from_string(content).unwrap();
let mut line_buffer = Vec::new();

story.start().unwrap();

match story.resume(&mut line_buffer).unwrap() {
    Prompt::Choice(choice_set) => {
        println!("Choose:");
        for (i, choice) in choice_set.iter().enumerate() {
            println!("{}. {}", i + 1, choice.text);
        }
    },
    Prompt::Done => { /* the story reached its end */ },
}

Variants

Done

The story reached an end.

Choice(Vec<Choice>)

A choice was encountered.

Implementations

impl Prompt

pub fn get_choices(&self) -> Option<Vec<Choice>>

If a set of choices was returned, retrieve them without having to match.

Examples

let content = "\
Professor Lidenbrock had barely a spattering of water left in his flask.
*   Axel got the last of it.
*   He pressed on, desperately hoping to find water soon.
";

let mut story = read_story_from_string(content).unwrap();
let mut line_buffer = Vec::new();

story.start().unwrap();

if let Some(choices) = story.resume(&mut line_buffer).unwrap().get_choices() {
    /* do what you want */
}

Trait Implementations

impl Debug for Prompt

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

Formats the value using the given formatter.