Struct papyrus::repl::Repl

pub struct Repl<S, Data> {
    pub data: ReplData<Data>,
    // some fields omitted
}

The repl structure. Stored as a state machine. See the [module level documentation] for more information.

A repl has different available methods depending on its state.

Fields

data: ReplData<Data>

The inner repl configuration data.

Implementations

impl<S, D> Repl<S, D>

These methods are available in any REPL state.

pub fn prompt(&self, colour: bool) -> String

The prompt.

Includes the module name, the editing/mutating state, the command path, the input symbol, and the trailing space. It also includes the colouring byte sequences if specified.

impl<D> Repl<Evaluate, D>

These methods are available when the REPL is in the Evaluate state.

pub fn eval(self, app_data: &mut D) -> EvalResult<D>

Evaluates the read input, compiling and executing the code and printing all line prints until a result is found. This result gets passed back as a print ready repl.

pub fn eval_async(self, app_data: &Arc<Mutex<D>>) -> Evaluating<D> where
    D: 'static + Send, 

Same as eval but will evaluate on another thread, not blocking this one.

An Arc::clone will be taken of app_data.

pub fn output_listen(&mut self) -> Receiver

Begin listening to line change events on the output.

pub fn close_channel(&mut self)

Close the sender side of the output channel.

pub fn output(&self) -> &str

The current output.

The output contains colouring ANSI escape codes, the prompt, and all input.

impl<D> Repl<Print, D>

These methods are available when the REPL is in the Print state.

pub fn print(self) -> (Repl<Read, D>, Option<(usize, Kserd<'static>)>)

Prints the result if successful as [out#] or the failure message if any. Uses the default formatter for the Kserd data.

pub fn print_with_formatting(
    self,
    config: FormattingConfig
) -> (Repl<Read, D>, Option<(usize, Kserd<'static>)>)

Prints the result if successful as [out#] or the failure message if any. Uses the given formatting configuration for the Kserd data. The return is (, <maybe <stmt index, data>>)

impl<D> Repl<Read, D>

These methods are available when the REPL is in the Read state.

pub fn line_input(&mut self, input: &str)

Overwrite the current line in the input buffer.

A line is considered if more input is required, the previous input stacked. Only overwrites the most recent buffer.

pub fn input_buffer(&self) -> &str

The current input buffer.

pub fn input_buffer_line(&self) -> &str

The line of the current input buffer.

This differs to the input buffer if there has been a requirement for More input, say if a block { was started and not closed out. The line is what has be set with line_input.

pub fn read(self) -> ReadResult<D>

Read the current contents of the input buffer. This may move the repl into an evaluating state.

pub fn output(&self) -> &str

The current output.

The output contains colouring ANSI escape codes, the prompt, and all input.

pub fn output_listen(&mut self) -> Receiver

Begin listening to line change events on the output.

pub fn close_channel(&mut self)

Close the sender side of the output channel.

impl<D> Repl<Read, D>

Available with the runnable feature and when the REPL is in the Read state.

pub fn run<T, U, V>(
    self,
    run_callbacks: RunCallbacks<D, T, U, V>
) -> Result<String> where
    T: FnMut(&Repl<Print, D>) -> FormattingConfig,
    U: FnMut(usize, Kserd<'static>, &Repl<Read, D>),
    V: FnOnce(&mut ReplData<D>, &mut D), 

Run the repl inside the terminal, consuming the repl. Returns the output of the REPL.

Trait Implementations

impl<S: Debug, D> Debug for Repl<S, D>

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

Formats the value using the given formatter.

impl<D> Default for Repl<Read, D>

fn default() -> Self

Returns the "default value" for a type.