Provide Distinct Builder for Reedline

.gitignore

@@ -23,3 +23,6 @@ tarpaulin-report.html
 *.rsproj
 *.rsproj.user
 *.sln
+
+# Visual Studio Code
+.vscode

examples/basic.rs

@@ -8,7 +8,7 @@ use std::io;
 
 fn main() -> io::Result<()> {
     // Create a new Reedline engine with a local History that is not synchronized to a file.
-    let mut line_editor = Reedline::create();
+    let mut line_editor = Reedline::new();
     let prompt = DefaultPrompt::default();
 
     loop {

examples/completions.rs

@@ -57,7 +57,7 @@ fn main() -> io::Result<()> {
         "abadarabc".into(),
     ];
 
-    let completer = Box::new(DefaultCompleter::new_with_wordlen(commands, 2));
+    let completer = DefaultCompleter::new_with_wordlen(commands, 2);
 
     // Use the interactive menu to select options from the completer
     let columnar_menu = ColumnarMenu::default()
@@ -71,12 +71,13 @@ fn main() -> io::Result<()> {
     let mut keybindings = default_emacs_keybindings();
     add_menu_keybindings(&mut keybindings);
 
-    let edit_mode = Box::new(Emacs::new(keybindings));
+    let edit_mode = Emacs::new(keybindings);
 
-    let mut line_editor = Reedline::create()
-        .with_completer(completer)
-        .with_menu(ReedlineMenu::EngineCompleter(completion_menu))
-        .with_edit_mode(edit_mode);
+    let mut line_editor = Reedline::builder()
+        .with_completions(completer)
+        .add_menu(ReedlineMenu::EngineCompleter(completion_menu))
+        .with_edit_mode(edit_mode)
+        .build();
 
     let prompt = DefaultPrompt::default();
 

examples/custom_prompt.rs

@@ -56,7 +56,7 @@ impl Prompt for CustomPrompt {
 
 fn main() -> io::Result<()> {
     println!("Custom prompt demo:\nAbort with Ctrl-C or Ctrl-D");
-    let mut line_editor = Reedline::create();
+    let mut line_editor = Reedline::new();
 
     let prompt = CustomPrompt(Cell::new(0), "Custom Prompt");
 

examples/cwd_aware_hinter.rs

@@ -25,12 +25,12 @@ fn create_item(cwd: &str, cmd: &str, exit_status: i64) -> reedline::HistoryItem
     }
 }
 
-fn create_filled_example_history(home_dir: &str, orig_dir: &str) -> Box<dyn reedline::History> {
+fn create_filled_example_history(home_dir: &str, orig_dir: &str) -> impl reedline::History {
     use reedline::History;
     #[cfg(not(any(feature = "sqlite", feature = "sqlite-dynlib")))]
     let mut history = Box::new(reedline::FileBackedHistory::new(100));
     #[cfg(any(feature = "sqlite", feature = "sqlite-dynlib"))]
-    let mut history = Box::new(reedline::SqliteBackedHistory::in_memory().unwrap());
+    let mut history = reedline::SqliteBackedHistory::in_memory().unwrap();
 
     history.save(create_item(orig_dir, "dummy", 0)).unwrap(); // add dummy item so ids start with 1
     history.save(create_item(orig_dir, "ls /usr", 0)).unwrap();
@@ -56,11 +56,12 @@ fn main() -> io::Result<()> {
         orig_dir.to_string_lossy().as_ref(),
     );
 
-    let mut line_editor = Reedline::create()
-        .with_hinter(Box::new(
+    let mut line_editor = Reedline::builder()
+        .with_hints(
             CwdAwareHinter::default().with_style(Style::new().bold().italic().fg(Color::Yellow)),
-        ))
-        .with_history(history);
+        )
+        .with_history(history)
+        .build();
 
     let prompt = DefaultPrompt::default();
 

examples/demo.rs

@@ -9,8 +9,8 @@ use {
     reedline::{
         default_emacs_keybindings, default_vi_insert_keybindings, default_vi_normal_keybindings,
         ColumnarMenu, DefaultCompleter, DefaultHinter, DefaultPrompt, DefaultValidator,
-        EditCommand, EditMode, Emacs, ExampleHighlighter, Keybindings, ListMenu, Reedline,
-        ReedlineEvent, ReedlineMenu, Signal, Vi,
+        EditCommand, Emacs, ExampleHighlighter, Keybindings, ListMenu, Reedline, ReedlineEvent,
+        ReedlineMenu, Signal, Vi,
     },
 };
 
@@ -33,16 +33,14 @@ fn main() -> reedline::Result<()> {
     };
 
     #[cfg(any(feature = "sqlite", feature = "sqlite-dynlib"))]
-    let history = Box::new(
-        reedline::SqliteBackedHistory::with_file(
-            "history.sqlite3".into(),
-            history_session_id,
-            Some(chrono::Utc::now()),
-        )
-        .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?,
-    );
+    let history = reedline::SqliteBackedHistory::with_file(
+        "history.sqlite3".into(),
+        history_session_id,
+        Some(chrono::Utc::now()),
+    )
+    .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
     #[cfg(not(any(feature = "sqlite", feature = "sqlite-dynlib")))]
-    let history = Box::new(FileBackedHistory::with_file(50, "history.txt".into())?);
+    let history = FileBackedHistory::with_file(50, "history.txt".into())?;
     let commands = vec![
         "test".into(),
         "clear".into(),
@@ -71,41 +69,38 @@ fn main() -> reedline::Result<()> {
         "こんにちは世界".into(),
         "こんばんは世界".into(),
     ];
-    let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
+    let completer = DefaultCompleter::new_with_wordlen(commands.clone(), 2);
 
     let cursor_config = CursorConfig {
         vi_insert: Some(SetCursorStyle::BlinkingBar),
         vi_normal: Some(SetCursorStyle::SteadyBlock),
         emacs: None,
     };
 
-    let mut line_editor = Reedline::create()
-        .with_history_session_id(history_session_id)
+    let mut builder = Reedline::builder()
+        .with_history_session_id(history_session_id.unwrap())
         .with_history(history)
-        .with_history_exclusion_prefix(Some(" ".to_string()))
-        .with_completer(completer)
-        .with_quick_completions(true)
-        .with_partial_completions(true)
+        .with_history_exclusion_prefix(" ".to_string())
+        .with_completions(completer)
+        .use_quick_completions(true)
+        .use_partial_completions(true)
         .with_cursor_config(cursor_config)
         .use_bracketed_paste(true)
         .use_kitty_keyboard_enhancement(true)
-        .with_highlighter(Box::new(ExampleHighlighter::new(commands)))
-        .with_hinter(Box::new(
-            DefaultHinter::default().with_style(Style::new().fg(Color::DarkGray)),
-        ))
-        .with_validator(Box::new(DefaultValidator))
-        .with_ansi_colors(true);
+        .with_highlighter(ExampleHighlighter::new(commands))
+        .with_hints(DefaultHinter::default().with_style(Style::new().fg(Color::DarkGray)))
+        .with_validator(DefaultValidator)
+        .use_ansi_colors(true);
 
     // Adding default menus for the compiled reedline
-    line_editor = line_editor
-        .with_menu(ReedlineMenu::EngineCompleter(Box::new(
+    builder = builder.add_menus(vec![
+        ReedlineMenu::EngineCompleter(Box::new(
             ColumnarMenu::default().with_name("completion_menu"),
-        )))
-        .with_menu(ReedlineMenu::HistoryMenu(Box::new(
-            ListMenu::default().with_name("history_menu"),
-        )));
+        )),
+        ReedlineMenu::HistoryMenu(Box::new(ListMenu::default().with_name("history_menu"))),
+    ]);
 
-    let edit_mode: Box<dyn EditMode> = if vi_mode {
+    if vi_mode {
         let mut normal_keybindings = default_vi_normal_keybindings();
         let mut insert_keybindings = default_vi_insert_keybindings();
 
@@ -114,22 +109,19 @@ fn main() -> reedline::Result<()> {
 
         add_newline_keybinding(&mut insert_keybindings);
 
-        Box::new(Vi::new(insert_keybindings, normal_keybindings))
+        builder = builder.with_edit_mode(Vi::new(insert_keybindings, normal_keybindings));
     } else {
         let mut keybindings = default_emacs_keybindings();
         add_menu_keybindings(&mut keybindings);
         add_newline_keybinding(&mut keybindings);
-
-        Box::new(Emacs::new(keybindings))
+        builder = builder.with_edit_mode(Emacs::new(keybindings));
     };
 
-    line_editor = line_editor.with_edit_mode(edit_mode);
-
     // Adding vi as text editor
     let temp_file = temp_dir().join("temp_file.nu");
     let mut command = Command::new("vi");
     command.arg(&temp_file);
-    line_editor = line_editor.with_buffer_editor(command, temp_file);
+    let mut line_editor = builder.with_buffer_editor(command, temp_file).build();
 
     let prompt = DefaultPrompt::default();
 

examples/external_printer.rs

@@ -38,7 +38,7 @@ fn main() {
         }
     });
 
-    let mut line_editor = Reedline::create().with_external_printer(printer);
+    let mut line_editor = Reedline::builder().with_external_printer(printer).build();
     let prompt = DefaultPrompt::default();
 
     loop {

examples/highlighter.rs

@@ -12,8 +12,9 @@ fn main() -> io::Result<()> {
         "hello world reedline".into(),
         "this is the reedline crate".into(),
     ];
-    let mut line_editor =
-        Reedline::create().with_highlighter(Box::new(ExampleHighlighter::new(commands)));
+    let mut line_editor = Reedline::builder()
+        .with_highlighter(ExampleHighlighter::new(commands))
+        .build();
     let prompt = DefaultPrompt::default();
 
     loop {

examples/hinter.rs

@@ -11,9 +11,9 @@ use reedline::{DefaultHinter, DefaultPrompt, Reedline, Signal};
 use std::io;
 
 fn main() -> io::Result<()> {
-    let mut line_editor = Reedline::create().with_hinter(Box::new(
-        DefaultHinter::default().with_style(Style::new().italic().fg(Color::LightGray)),
-    ));
+    let mut line_editor = Reedline::builder()
+        .with_hints(DefaultHinter::default().with_style(Style::new().italic().fg(Color::LightGray)))
+        .build();
     let prompt = DefaultPrompt::default();
 
     loop {

examples/history.rs

@@ -10,12 +10,10 @@ use reedline::{DefaultPrompt, FileBackedHistory, Reedline, Signal};
 use std::io;
 
 fn main() -> io::Result<()> {
-    let history = Box::new(
-        FileBackedHistory::with_file(5, "history.txt".into())
-            .expect("Error configuring history with file"),
-    );
+    let history = FileBackedHistory::with_file(5, "history.txt".into())
+        .expect("Error configuring history with file");
 
-    let mut line_editor = Reedline::create().with_history(history);
+    let mut line_editor = Reedline::builder().with_history(history).build();
     let prompt = DefaultPrompt::default();
 
     loop {

examples/ide_completions.rs

@@ -82,7 +82,7 @@ fn main() -> io::Result<()> {
         "abadarabc".into(),
     ];
 
-    let completer = Box::new(DefaultCompleter::new_with_wordlen(commands, 2));
+    let completer = DefaultCompleter::new_with_wordlen(commands, 2);
 
     // Use the interactive menu to select options from the completer
     let mut ide_menu = IdeMenu::default()
@@ -107,12 +107,13 @@ fn main() -> io::Result<()> {
     let mut keybindings = default_emacs_keybindings();
     add_menu_keybindings(&mut keybindings);
 
-    let edit_mode = Box::new(Emacs::new(keybindings));
+    let edit_mode = Emacs::new(keybindings);
 
-    let mut line_editor = Reedline::create()
-        .with_completer(completer)
-        .with_menu(ReedlineMenu::EngineCompleter(completion_menu))
-        .with_edit_mode(edit_mode);
+    let mut line_editor = Reedline::builder()
+        .with_completions(completer)
+        .add_menu(ReedlineMenu::EngineCompleter(completion_menu))
+        .with_edit_mode(edit_mode)
+        .build();
 
     let prompt = DefaultPrompt::default();
 

examples/transient_prompt.rs

@@ -89,31 +89,31 @@ fn main() -> io::Result<()> {
         "hello world reedline".into(),
         "this is the reedline crate".into(),
     ];
-    let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
+    let completer = DefaultCompleter::new_with_wordlen(commands.clone(), 2);
     // Use the interactive menu to select options from the completer
     let completion_menu = Box::new(ColumnarMenu::default().with_name("completion_menu"));
 
     let mut keybindings = default_emacs_keybindings();
     add_menu_keybindings(&mut keybindings);
 
-    let edit_mode = Box::new(Emacs::new(keybindings));
+    let edit_mode = Emacs::new(keybindings);
 
-    let mut line_editor = Reedline::create()
-        .with_hinter(Box::new(
-            DefaultHinter::default().with_style(Style::new().fg(Color::LightGray)),
-        ))
-        .with_completer(completer)
-        .with_menu(ReedlineMenu::EngineCompleter(completion_menu))
+    #[allow(unused_mut)]
+    let mut builder = Reedline::builder()
+        .with_hints(DefaultHinter::default().with_style(Style::new().fg(Color::LightGray)))
+        .with_completions(completer)
+        .add_menu(ReedlineMenu::EngineCompleter(completion_menu))
         .with_edit_mode(edit_mode)
-        .with_highlighter(Box::new(ExampleHighlighter::new(commands)))
-        .with_validator(Box::new(CustomValidator {}))
-        .with_ansi_colors(true)
-        .with_history_exclusion_prefix(Some(String::from(" ")))
-        .with_transient_prompt(Box::new(TransientPrompt {}));
+        .with_highlighter(ExampleHighlighter::new(commands))
+        .with_validator(CustomValidator {})
+        .use_ansi_colors(true)
+        .with_history_exclusion_prefix(String::from(" "))
+        .with_transient_prompt(TransientPrompt {});
     #[cfg(any(feature = "sqlite", feature = "sqlite-dynlib"))]
     {
-        line_editor = line_editor.with_history(Box::new(SqliteBackedHistory::in_memory().unwrap()));
-    }
+        builder = builder.with_history(SqliteBackedHistory::in_memory().unwrap());
+    };
+    let mut line_editor = builder.build();
 
     let prompt = DefaultPrompt::default();
 

examples/validator.rs

@@ -21,8 +21,10 @@ impl Validator for CustomValidator {
 }
 
 fn main() -> io::Result<()> {
-    println!("Input \"complete\" followed by [Enter], will accept the input line (Signal::Succeed will be called)\nPressing [Enter] will in other cases give you a multi-line prompt.\nAbort with Ctrl-C or Ctrl-D");
-    let mut line_editor = Reedline::create().with_validator(Box::new(CustomValidator));
+    println!("Input \"complete\" followed by [Enter], will accept the input line (Signal::Succeed will be called)");
+    println!("Pressing [Enter] will in other cases give you a multi-line prompt.");
+    println!("Abort with Ctrl-C or Ctrl-D");
+    let mut line_editor = Reedline::builder().with_validator(CustomValidator).build();
 
     let prompt = DefaultPrompt::default();
 

src/completion/default.rs

@@ -18,9 +18,9 @@ use std::{
 ///  "hello world reedline".into(),
 ///  "this is the reedline crate".into(),
 /// ];
-/// let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
+/// let completer = DefaultCompleter::new_with_wordlen(commands.clone(), 2);
 ///
-/// let mut line_editor = Reedline::create().with_completer(completer);
+/// let mut line_editor = Reedline::builder().with_completions(completer).build();
 /// ```
 #[derive(Debug, Clone)]
 pub struct DefaultCompleter {