Struct Dialog 

pub struct Dialog {
    pub name: String,
    pub description: String,
    pub steps: Vec<DialogStep>,
    pub entry: Option<String>,
    pub variables: HashMap<String, String>,
}

A complete dialog definition.

Fields

name: String

Name of the dialog.

description: String

Description.

steps: Vec<DialogStep>

Steps in the dialog.

entry: Option<String>

Entry point step name.

variables: HashMap<String, String>

Variables for substitution.

Implementations

impl Dialog

pub fn new() -> Self

Create a new empty dialog.

pub fn named(name: impl Into<String>) -> Self

Create a new dialog with a name.

pub fn description(self, desc: impl Into<String>) -> Self

Set the description.

pub fn step(self, step: DialogStep) -> Self

Add a step.

pub fn variable(self, name: impl Into<String>, value: impl Into<String>) -> Self

Set a variable.

pub fn entry_point(self, step: impl Into<String>) -> Self

Set the entry point.

pub const fn len(&self) -> usize

Get the number of steps.

pub const fn is_empty(&self) -> bool

Check if the dialog is empty.

pub fn steps(&self) -> &[DialogStep]

Get the steps.

pub const fn variables(&self) -> &HashMap<String, String>

Get the variables.

pub fn get_step(&self, name: &str) -> Option<&DialogStep>

Get a step by name.

pub fn substitute(&self, s: &str) -> String

Substitute variables in a string.

Trait Implementations

impl Clone for Dialog

fn clone(&self) -> Dialog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dialog

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

Formats the value using the given formatter.

impl Default for Dialog

fn default() -> Dialog

Returns the “default value” for a type.