Struct ReadLine 

pub struct ReadLine<I = ReadLineInfo>
where
    I: ApplicationInfo<ContentId = ReadLineId>,
{ /* private fields */ }

Simple editor for collecting user input.

Implementations

impl<I> ReadLine<I>

where I: ApplicationInfo<ContentId = ReadLineId>,

pub fn new<B: BindingMachine<TerminalKey, Action<I>, RepeatType, EditContext> + 'static>( bindings: B, ) -> Result<Self, Error>

where I::Store: Default,

Create a new instance.

Examples found in repository

examples/read-loop.rs (line 59)

fn create_readline(mode: MixedChoice) -> Result<ReadLine, std::io::Error> {
    match mode {
        MixedChoice::Emacs => {
            let mut emacs = EmacsMachine::empty();
            EmacsBindings::default().submit_on_enter().setup(&mut emacs);
            ReadLine::new(emacs)
        },
        _ => {
            let mut vi = VimMachine::<TerminalKey, ReadLineInfo>::empty();
            VimBindings::default().submit_on_enter().setup(&mut vi);
            ReadLine::new(vi)
        },
    }
}

pub fn readline(&mut self, prompt: Option<String>) -> ReadLineResult<I>

Prompt the user for input.

Examples found in repository

examples/read-loop.rs (line 19)

fn main() -> Result<(), std::io::Error> {
    let mode = select_mode();
    let mut rl = create_readline(mode)?;

    println!("Reading input in {mode:?} mode; 'q' or 'quit' quits the loop.");

    loop {
        match rl.readline(Some("> ".to_string())) {
            Ok(s) => {
                match s.trim() {
                    "q" | "quit" => {
                        return Ok(());
                    },
                    _ => {
                        println!("User typed: {:?}", s);
                    },
                }
            },
            Err(e) => {
                // Print out editor error messages.
                println!("{}", e);
            },
        }
    }
}