Struct easy_repl::repl::ReplBuilder

pub struct ReplBuilder<'a> { /* fields omitted */ }

Builder pattern implementation for Repl.

All setter methods take owned self so the calls can be chained, for example:

let repl = Repl::builder()
    .description("My REPL")
    .prompt("repl> ")
    .build()
    .expect("Failed to build REPL");

Implementations

impl<'a> ReplBuilder<'a>

pub fn description<T: Into<String>>(self, v: T) -> Self

Repl description shown in Repl::help. Defaults to an empty string.

pub fn prompt<T: Into<String>>(self, v: T) -> Self

Prompt string, defaults to "> ".

pub fn text_width<T: Into<usize>>(self, v: T) -> Self

Width of the text used when wrapping the help message. Defaults to 80.

pub fn editor_config<T: Into<Config>>(self, v: T) -> Self

Configuration for rustyline. Some sane defaults are used.

pub fn out<T: Into<Box<dyn Write>>>(self, v: T) -> Self

Where to print REPL output. By default std::io::Stderr is used.

Note that rustyline will always use std::io::Stderr or std::io::Stdout. These must be configured in ReplBuilder::editor_config, and currently there seems to be no way to use other output stream for rustyline (which probably also makes little sense).

pub fn with_hints<T: Into<bool>>(self, v: T) -> Self

Print command hints. Defaults to true.

Hints will show the end of a command if there is only one avaliable. For example, assuming commands "move" and "make", in the following position (| indicates the cursor):

> mo|

a hint will be shown as

> mo|ve

but when there is only

> m|

then no hints will be shown.

pub fn with_completion<T: Into<bool>>(self, v: T) -> Self

Use completion. Defaults to true.

pub fn with_filename_completion<T: Into<bool>>(self, v: T) -> Self

Add filename completion, besides command completion. Defaults to false.

pub fn predict_commands<T: Into<bool>>(self, v: T) -> Self

Execute commands when entering incomplete names. Defaults to true.

With this option commands can be executed by entering only part of command name. If there is only a single command mathing given prefix, then it will be executed. For example, with commands "make" and “move”, entering just mo will resolve to move and the command will be executed, but entering m will result in an error.

pub fn add(self, name: &str, cmd: Command<'a>) -> Self

Add a command with given name. Use along with the command! macro.

pub fn build(self) -> Result<Repl<'a>, BuilderError>

Finalize the configuration and return the REPL or error.

Trait Implementations

impl<'a> Default for ReplBuilder<'a>

fn default() -> Self

Returns the “default value” for a type.