Struct papyrus::repl::ReplData

pub struct ReplData<Data> {
    pub cmdtree: Commander<CommandResult<Data>>,
    pub prompt_colour: Color,
    pub out_colour: Color,
    pub editing: Option<EditingIndex>,
    pub editing_src: Option<String>,
    pub loaded_libs_size_limit: usize,
    // some fields omitted
}

The inner configuration data of the repl.

Fields

cmdtree: Commander<CommandResult<Data>>

The REPL commands as a cmdtree::Commander.

prompt_colour: Color

The colour of the prompt region. ie papyrus.

out_colour: Color

The colour of the out component. ie [out0].

editing: Option<EditingIndex>

Flag for editing a statement, item, or crate.

If a value is set when an evaluation starts, the input buffer will be used to overwrite the element at the given index (if it exists). Compilation and evaluation could both fail, but the change will not be reverted.

If the index is outside the array bounds then there will be no change. Evaluation phase will still run.

editing_src: Option<String>

The rust source code as a string which is being edited.

This is helpful if an alteration has been requested and you want to show the old source code. It is recommended to .take() the value to avoid repeating the contents.

loaded_libs_size_limit: usize

Limit the number of loaded libraries that are kept in memory and not dropped.

There exists a use pattern which can create segmentation faults if code defined in the library is called once the library goes out of scope and is dropped. Detailed in #44.

Libraries are returned on a successful execution and stored in a vector. Once the vector reaches the size limit, the oldest library is removed and dropped, freeing resources.

The default is to keep the size limit at zero, thus ensuring no libraries are kept in memory. This is recommended unless issues are arising from esoteric use cases.

Methods

impl<D> ReplData<D>

pub fn with_cmdtree_builder(
    &mut self,
    builder: Builder<CommandResult<D>>
) -> Result<&mut Self, BuildError>

Uses the given Builder as the root of the command tree.

An error will be returned if any command already exists.

impl<Data> ReplData<Data>

pub fn with_compilation_dir<P: AsRef<Path>>(
    &mut self,
    dir: P
) -> Result<&mut Self>

Set the compilation directory. The default is set to $HOME/.papyrus.

pub fn with_external_lib(&mut self, lib: Extern) -> &mut Self

Link an external library.

This is primarily used for linking the calling library, and there is a function on Extern to work this path out. It is better to use crates.io than linking libraries, but this method allows for linking libraries not on crates.io.

See linking module

pub fn current_mod(&self) -> &Path

The current mod that is being repl'd on.

pub fn current_src(&self) -> &SourceCode

The current source code, this is short hand for self.mods_map().get(self.current_mod()).unwrap().

pub fn mods_map(&self) -> &ModsMap

The current file map, mappings of modules to source code.

pub fn linking(&self) -> &LinkingConfiguration

The current linking configuration. Not mutable as it could lead to undefined behaviour if changed.

pub fn persistent_module_code(&mut self) -> &mut String

A mutable reference to the persistent module code.

This code gets written to each module and can be used to create generic imports. It is also specifically used to solve dependency duplication if an external library is being linked. Dependency duplication is discussed in the linking module.

pub fn static_files(&self) -> &StaticFiles

The current static files.

pub fn add_static_file(
    &mut self,
    path: PathBuf,
    code: &str
) -> Result<bool, AddingStaticFileError>

Add a static file.

The code will be written to disk. The path must be valid, and as they are used for module paths, must be valid identifiers. See StaticFile.

pub fn remove_static_file<P: AsRef<Path>>(&mut self, path: P) -> bool

Remove a static file.

Returns true if the path existed. Any io errors are swallowed.

pub fn clear_loaded_libs(&mut self)

Clears the cached loaded libraries.

This can be used to clear resources. Loaded libraries are stored up to the loaded_libs_size_limit but can be cleared earlier if need be.

pub unsafe fn set_data_type(self, data_type: &str) -> Self

Not meant to used by developer. Use the macros instead. See linking module

Safety

Incorrect matching of type will cause undefined behaviour when the REPL evaluates. It will most likely segfault. Use is not recommended, rather there are macros that correctly map the type across which are intended for use.

Trait Implementations

impl<Data> Default for ReplData<Data>

fn default() -> Self

Returns the "default value" for a type.