Struct dialog::Input

pub struct Input { /* private fields */ }

A dialog box with a text input field.

This dialog box displays a text and an input field. It returns the text entered by the user or None if the user cancelled the dialog.

Example

use dialog::DialogBox;

let name = dialog::Input::new("Please enter your name")
    .title("Name")
    .show()
    .expect("Could not display dialog box");
match name {
    Some(name) => println!("Hello {}!", name),
    None => println!("Hello stranger!"),
};

Implementations

impl Input

pub fn new(text: impl Into<String>) -> Input

Creates a new input dialog box with the given text.

pub fn title(&mut self, title: impl Into<String>) -> &mut Input

Sets the title of this input box.

This method returns a reference to self to enable chaining.

pub fn default(&mut self, default: impl Into<String>) -> &mut Input

Sets the default value of this input box.

This method returns a reference to self to enable chaining.

Trait Implementations

impl DialogBox for Input

type Output = Option<String>

The type of the data returned by the dialog box.

fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output>where
    B: Backend + ?Sized,

Shows this dialog box using the given backend and returns the output.

fn show(&self) -> Result<Self::Output>

Shows this dialog box using the default backend and returns the output.