Struct Prompt

pub struct Prompt<'a> { /* private fields */ }

Untyped builder for reading and parsing CLI input.

Implementations

impl<'a> Prompt<'a>

pub fn new(message: &'a str) -> Self

Create a new prompt with a message.

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

Provide a default value as string. If the user hits ENTER with empty input, default will be used and parsed as the target type.

Examples found in repository

examples/basic.rs (line 5)

fn main() -> Result<(), askit::Error> {
    let name: String = prompt("Name: ").get()?;
    let age: u8 = prompt("Age: ").default("18").retries(2).get()?;
    println!("Hello, {name} ({age}).");
    Ok(())
}

pub fn retries(self, retries: usize) -> Self

Number of times to retry when parsing fails or input is empty w/o default.

Examples found in repository

examples/basic.rs (line 5)

fn main() -> Result<(), askit::Error> {
    let name: String = prompt("Name: ").get()?;
    let age: u8 = prompt("Age: ").default("18").retries(2).get()?;
    println!("Hello, {name} ({age}).");
    Ok(())
}

pub fn trim(self, yes: bool) -> Self

Whether to trim whitespace (default: true).

pub fn to<T>(self) -> TypedPrompt<'a, T>

where T: FromStr, T::Err: Display,

Convert to a typed builder, enabling .default_val() and .validate().

Examples found in repository

examples/default_typed.rs (line 6)

fn main() -> Result<(), askit::Error> {
    // Default tipado: não precisa parse
    let port: u16 = prompt("Port [typed default=5432]: ")
        .to()
        .default_val(5432)
        .get()?;

    println!("Port = {port}");
    Ok(())
}

examples/validate.rs (line 5)

fn main() -> Result<(), askit::Error> {
    let port: u32 = prompt("Port: ")
        .to()
        .retries(2)
        .validate(|p| (1..=65535).contains(p))
        .message("Port must be in 1..=65535")
        .get()?;

    println!("Using port {port}");
    Ok(())
}

pub fn get<T>(&self) -> Result<T, Error>

where T: FromStr, T::Err: Display,

Read from stdin, parse and return the desired type.

Examples found in repository

examples/basic.rs (line 4)

fn main() -> Result<(), askit::Error> {
    let name: String = prompt("Name: ").get()?;
    let age: u8 = prompt("Age: ").default("18").retries(2).get()?;
    println!("Hello, {name} ({age}).");
    Ok(())
}

pub fn get_with<T, R, W>( &self, reader: &mut R, writer: &mut W, ) -> Result<T, Error>

where T: FromStr, T::Err: Display, R: BufRead, W: Write,

Same as get(), but allows providing a custom reader and writer.