Struct rune::Build

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

High level helper for setting up a build of Rune sources into a Unit.

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_context 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_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.