Struct dialoguer::BasicHistory

pub struct BasicHistory { /* private fields */ }

Implementations

impl BasicHistory

pub fn new() -> Self

Creates a new basic history value which has no limit on the number of entries and allows for duplicates.

Example

A history with at most 8 entries and no duplicates:

let mut history = BasicHistory::new().max_entries(8).no_duplicates(true);

Examples found in repository

examples/history.rs (line 10)

fn main() {
    println!("Use 'exit' to quit the prompt");
    println!("In this example, history is limited to 8 entries and contains no duplicates");
    println!("Use the Up/Down arrows to scroll through history");
    println!();

    let mut history = BasicHistory::new().max_entries(8).no_duplicates(true);

    loop {
        if let Ok(cmd) = Input::<String>::with_theme(&ColorfulTheme::default())
            .with_prompt("dialoguer")
            .history_with(&mut history)
            .interact_text()
        {
            if cmd == "exit" {
                process::exit(0);
            }
            println!("Entered {}", cmd);
        }
    }
}

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

Limit the number of entries stored in the history.

Examples found in repository

examples/history.rs (line 10)

fn main() {
    println!("Use 'exit' to quit the prompt");
    println!("In this example, history is limited to 8 entries and contains no duplicates");
    println!("Use the Up/Down arrows to scroll through history");
    println!();

    let mut history = BasicHistory::new().max_entries(8).no_duplicates(true);

    loop {
        if let Ok(cmd) = Input::<String>::with_theme(&ColorfulTheme::default())
            .with_prompt("dialoguer")
            .history_with(&mut history)
            .interact_text()
        {
            if cmd == "exit" {
                process::exit(0);
            }
            println!("Entered {}", cmd);
        }
    }
}

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

Prevent duplicates in the history. This means that any previous entries that are equal to a new entry are removed before the new entry is added.

Examples found in repository

examples/history.rs (line 10)

fn main() {
    println!("Use 'exit' to quit the prompt");
    println!("In this example, history is limited to 8 entries and contains no duplicates");
    println!("Use the Up/Down arrows to scroll through history");
    println!();

    let mut history = BasicHistory::new().max_entries(8).no_duplicates(true);

    loop {
        if let Ok(cmd) = Input::<String>::with_theme(&ColorfulTheme::default())
            .with_prompt("dialoguer")
            .history_with(&mut history)
            .interact_text()
        {
            if cmd == "exit" {
                process::exit(0);
            }
            println!("Entered {}", cmd);
        }
    }
}

Trait Implementations

impl Default for BasicHistory

fn default() -> Self

Returns the “default value” for a type.

impl<T: ToString> History<T> for BasicHistory

fn read(&self, pos: usize) -> Option<String>

This is called with the current position that should be read from history. The pos represents the number of times the Up/Down arrow key has been pressed. This would normally be used as an index to some sort of vector. If the pos does not have an entry, None should be returned.

fn write(&mut self, val: &T)

This is called with the next value you should store in history at the first location. Normally history is implemented as a FIFO queue.