Struct Build 

pub struct Build<'a, S> { /* private fields */ }

A builder for a Unit.

See rune::prepare for more.

Implementations

impl<'a, S> Build<'a, S>

pub fn with_context(self, context: &'a Context) -> Self

Modify the current Build to use the given Context while building.

If unspecified the empty context constructed with Context::new will be used. Since this counts as building without a context, Vm::without_runtime can be used when running the produced Unit.

pub fn with_diagnostics(self, diagnostics: &'a mut Diagnostics) -> Self

Modify the current Build to use the given Diagnostics collection.

pub fn with_options(self, options: &'a Options) -> Self

Modify the current Build to use the given Options.

pub fn with_arg(self, arg: impl AsRef<str>) -> Result<Self>

Associate an implicit argument with the build.

When the produced unit is executed as a script, this argument will be part of the top-level function that is being defined.

This requires Options::script to be set. See the scripts example.

Examples

use rune::{Source, Sources, Options};

let mut sources = Sources::new();
sources.insert(Source::memory("(a + b * 2) / c")?)?;

let mut options = Options::from_default_env()?;
options.script(true);

let result = rune::prepare(&mut sources)
    .with_args(["a", "b"])?
    .with_arg("c")?
    .with_options(&options)
    .build()?;

pub fn with_args( self, args: impl IntoIterator<Item: AsRef<str>>, ) -> Result<Self>

Associate a collection of implicit arguments with the build.

When the produced unit is executed as a script, this argument will be part of the top-level function that is being defined.

This requires Options::script to be set. See the scripts example.

Examples

use rune::{Source, Sources, Options};

let mut sources = Sources::new();
sources.insert(Source::memory("(a + b * 2) / c")?)?;

let mut options = Options::from_default_env()?;
options.script(true);

let result = rune::prepare(&mut sources)
    .with_args(["a", "b"])?
    .with_arg("c")?
    .with_options(&options)
    .build()?;

pub fn with_visitor(self, visitor: &'a mut dyn CompileVisitor) -> Result<Self>

Modify the current Build to configure the given CompileVisitor.

A compile visitor allows for custom collecting of compile-time metadata. Like if you want to collect every function that is discovered in the project.

pub fn with_source_loader(self, source_loader: &'a mut dyn SourceLoader) -> Self

Modify the current Build to configure the given SourceLoader.

Source loaders are used to determine how sources are loaded externally from the current file (as is neede when a module is imported).

pub fn build(self) -> Result<Unit<S>, BuildError>

where S: Default + UnitEncoder,

Build a Unit with the current configuration.

See rune::prepare for more.

impl<'a> Build<'a, DefaultStorage>

pub fn build_vm(self) -> Result<Vm, BuildError>

Convenience method to build a Vm directly from the current build using default storage.