Struct rune::Context

pub struct Context { /* private fields */ }

Context used for the Rune language.

See Build::with_context.

At runtime this needs to be converted into a RuntimeContext when used with a Vm. This is done through Context::runtime.

A Context contains:

• Native functions.
• Native instance functions.
• And native type definitions.

Implementations

impl Context

pub fn new() -> Self

Construct a new empty Context.

pub fn with_config(stdio: bool) -> Result<Self, ContextError>

Construct a Context containing the default set of modules with the given configuration.

stdio determines if we include I/O functions that interact with stdout and stderr by default, like dbg, print, and println. If this is false all the corresponding low-level I/O functions have to be provided through a different module.

These are:

• ::std::io::dbg
• ::std::io::print
• ::std::io::println

pub fn with_default_modules() -> Result<Self, ContextError>

Construct a new collection of functions with default packages installed.

pub fn runtime(&self) -> RuntimeContext

Construct a runtime context used when executing the virtual machine.

This is not a cheap operation, since it requires cloning things out of the build-time Context which are necessary at runtime.

use rune::{Context, Vm, Unit};
use std::sync::Arc;

let context = Context::with_default_modules()?;

let runtime = Arc::new(context.runtime());
let unit = Arc::new(Unit::default());

let vm = Vm::new(runtime, unit);

pub fn install(&mut self, module: &Module) -> Result<(), ContextError>

Install the specified module.

This installs everything that has been declared in the given Module and ensures that they are compatible with the overall context, like ensuring that a given type is only declared once.

pub fn iter_functions(&self) -> impl Iterator<Item = (Hash, &ContextSignature)>

Iterate over all available functions in the Context.

pub fn iter_types(&self) -> impl Iterator<Item = (Hash, &ContextTypeInfo)>

Iterate over all available types in the Context.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Context

Returns the “default value” for a type.