Struct Editor

pub struct Editor<C: Completer> { /* private fields */ }

Line editor

Implementations

impl<C: Completer> Editor<C>

pub fn new() -> Editor<C>

pub fn with_config(config: Config) -> Editor<C>

pub fn readline(&mut self, prompt: &str) -> Result<String>

This method will read a line from STDIN and will display a prompt

pub fn load_history<P: AsRef<Path> + ?Sized>(&mut self, path: &P) -> Result<()>

Load the history from the specified file.

pub fn save_history<P: AsRef<Path> + ?Sized>(&self, path: &P) -> Result<()>

Save the history in the specified file.

pub fn add_history_entry<S: AsRef<str> + Into<String>>( &mut self, line: S, ) -> bool

Add a new entry in the history.

pub fn clear_history(&mut self)

Clear history.

pub fn get_history(&mut self) -> &mut History

Return a reference to the history object.

pub fn set_completer(&mut self, completer: Option<C>)

Register a callback function to be called for tab-completion.

pub fn iter<'a>(&'a mut self, prompt: &'a str) -> Iter<'_, C>

let mut rl = tcalc_rustyline::Editor::<()>::new();
for readline in rl.iter("> ") {
    match readline {
        Ok(line) => {
            println!("Line: {}", line);
        },
        Err(err) => {
            println!("Error: {:?}", err);
            break
        }
    }
}

Trait Implementations

impl<C: Completer> Debug for Editor<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.