Struct rune::cli::Entry

pub struct Entry<'a> { /* private fields */ }

Available on crate feature cli only.

A rune-based entrypoint used for custom applications.

This can be used to construct your own rune-based environment, with a custom configuration such as your own modules.

Implementations

impl<'a> Entry<'a>

pub fn new() -> Self

Entry point.

pub fn about(self, about: impl Display) -> Self

Set about string used in cli output.

For example, this is the first row outputted when the command prints its help text.

Examples

rune::cli::Entry::new()
    .about("My own interpreter")
    .run();

pub fn context(self, context: &'a mut ContextBuilder) -> Self

Configure context to use using a builder.

Examples

use rune::{Context, ContextError, Module};

fn my_module() -> Result<Module, ContextError> {
    let module = Module::default();
    /* install things into module */
    Ok(module)
}

rune::cli::Entry::new()
    .about("My own interpreter")
    .context(&mut |opts| {
        let mut c = Context::with_config(opts.capture.is_none())?;
        c.install(my_module()?);
        Ok(c)
    })
    .run();

pub fn run(self) -> !

Run the configured application.

This will take over stdout and stdin.

Trait Implementations

impl<'a> Default for Entry<'a>

fn default() -> Entry<'a>

Returns the “default value” for a type.