Struct demand::Input

pub struct Input {
    pub title: String,
    pub description: String,
    pub prompt: String,
    pub placeholder: String,
    pub inline: bool,
    pub password: bool,
    pub input: String,
    pub theme: Theme,
    /* private fields */
}

Single line text input

Example

use demand::Input;

let input = Input::new("What's your name?")
  .description("We'll use this to personalize your experience.")
  .placeholder("Enter your name");
let name = input.run().expect("error running input");

Fields

title: String

The title of the input

description: String

A description to display after the title

prompt: String

A prompt to display after the description

placeholder: String

A placeholder to display in the input

inline: bool

Show the input inline

password: bool

Whether to mask the input

input: String

Input entered by the user

theme: Theme

Colors/style of the input

Implementations

impl Input

pub fn new<S: Into<String>>(title: S) -> Self

Creates a new input with the given title.

Examples found in repository

examples/input-password.rs (line 4)

fn main() {
    let t = Input::new("Set a password")
        .placeholder("Enter password")
        .prompt("Password: ")
        .password(true);
    let i = t.run().expect("error running input");
    println!("Password: {}", i);
}

examples/input.rs (line 4)

fn main() {
    let t = Input::new("What's your name?")
        .description("We'll use this to personalize your experience.")
        .placeholder("Enter your name")
        .prompt("Name: ");
    let i = t.run().expect("error running input");
    println!("Input: {}", i);
}

pub fn description(self, description: &str) -> Self

Sets the description of the input. If the input is inline, it is displayed to the right of the title. Otherwise, it is displayed below the title.

Examples found in repository

examples/input.rs (line 5)

fn main() {
    let t = Input::new("What's your name?")
        .description("We'll use this to personalize your experience.")
        .placeholder("Enter your name")
        .prompt("Name: ");
    let i = t.run().expect("error running input");
    println!("Input: {}", i);
}

pub fn inline(self, inline: bool) -> Self

Sets the inline flag of the input. If true, the input is displayed inline with the title

pub fn password(self, password: bool) -> Self

Sets the password flag of the input. If true, the input is masked with asterisks

Examples found in repository

examples/input-password.rs (line 7)

fn main() {
    let t = Input::new("Set a password")
        .placeholder("Enter password")
        .prompt("Password: ")
        .password(true);
    let i = t.run().expect("error running input");
    println!("Password: {}", i);
}

pub fn placeholder(self, placeholder: &str) -> Self

Sets the placeholder of the input. The placeholder is displayed in the input before the user enters any text

Examples found in repository

examples/input-password.rs (line 5)

fn main() {
    let t = Input::new("Set a password")
        .placeholder("Enter password")
        .prompt("Password: ")
        .password(true);
    let i = t.run().expect("error running input");
    println!("Password: {}", i);
}

examples/input.rs (line 6)

fn main() {
    let t = Input::new("What's your name?")
        .description("We'll use this to personalize your experience.")
        .placeholder("Enter your name")
        .prompt("Name: ");
    let i = t.run().expect("error running input");
    println!("Input: {}", i);
}

pub fn prompt(self, prompt: &str) -> Self

Sets the prompt of the input. The prompt is displayed after the title and description. If empty, the default prompt > is displayed.

Examples found in repository

examples/input-password.rs (line 6)

fn main() {
    let t = Input::new("Set a password")
        .placeholder("Enter password")
        .prompt("Password: ")
        .password(true);
    let i = t.run().expect("error running input");
    println!("Password: {}", i);
}

examples/input.rs (line 7)

fn main() {
    let t = Input::new("What's your name?")
        .description("We'll use this to personalize your experience.")
        .placeholder("Enter your name")
        .prompt("Name: ");
    let i = t.run().expect("error running input");
    println!("Input: {}", i);
}

pub fn theme(self, theme: Theme) -> Self

Sets the theme of the input

pub fn run(self) -> Result<String>

Displays the input to the user and returns the response

Examples found in repository

examples/input-password.rs (line 8)

fn main() {
    let t = Input::new("Set a password")
        .placeholder("Enter password")
        .prompt("Password: ")
        .password(true);
    let i = t.run().expect("error running input");
    println!("Password: {}", i);
}

examples/input.rs (line 8)

fn main() {
    let t = Input::new("What's your name?")
        .description("We'll use this to personalize your experience.")
        .placeholder("Enter your name")
        .prompt("Name: ");
    let i = t.run().expect("error running input");
    println!("Input: {}", i);
}