Struct rustyline_async::Readline

pub struct Readline { /* private fields */ }

Structure that contains all the data necessary to read and write lines in an asyncronous manner

Implementations

impl Readline

pub fn new(prompt: String) -> Result<(Self, SharedWriter), ReadlineError>

Create new Readline

pub fn set_max_history(&mut self, max_size: usize)

Set max history length

pub fn should_print_line_on(&mut self, enter: bool, control_c: bool)

Set whether the input line should remain on the screen after events.

If enter is true, then when the user presses “Enter”, the prompt and the text they entered will remain on the screen, and the cursor will move to the next line. If enter is false, the prompt & input will be erased instead.

control_c similarly controls the behavior for when the user presses Ctrl-C.

The default value for both settings is true.

pub fn flush(&mut self) -> Result<(), ReadlineError>

Flush all writers to terminal

pub async fn readline(&mut self) -> Result<String, ReadlineError>

Polling function for readline, manages all input and output.

pub fn add_history_entry(&mut self, entry: String) -> Option<()>

Add history entry asyncronously

Trait Implementations

impl Drop for Readline

fn drop(&mut self)

Executes the destructor for this type.