Struct rustyscript::RuntimeBuilder

pub struct RuntimeBuilder(/* private fields */);

A builder for creating a new runtime Just a helper wrapper around RuntimeOptions for Runtime and SnapshotBuilder

Example

use rustyscript::RuntimeBuilder;

let runtime = RuntimeBuilder::new()
    .with_timeout(std::time::Duration::from_secs(5))
    .with_default_entrypoint("main".to_string())
    .with_cryto_seed(42)
    .build()
    .expect("Failed to create runtime");

Implementations

impl RuntimeBuilder

pub fn new() -> Self

Create a new runtime builder with default options

pub fn with_extension(self, extension: Extension) -> Self

Add an extension to the runtime This can be used to add custom functionality to the runtime If the extension is for use with a snapshot, create the extension with init_ops instead of init_ops_and_esm

pub fn with_extensions(self, extensions: Vec<Extension>) -> Self

Add multiple extensions to the runtime This can be used to add custom functionality to the runtime If the extension is for use with a snapshot, create the extension with init_ops instead of init_ops_and_esm

pub fn with_default_entrypoint(self, entrypoint: String) -> Self

Set the default entrypoint for the runtime This is the function to use as entrypoint if a module does not provide one

pub fn with_timeout(self, timeout: Duration) -> Self

Set the timeout for the runtime This is the maximum time a script can run before it is terminated

pub fn with_import_provider( self, import_provider: Box<dyn ImportProvider>, ) -> Self

Add an import provider for the module loader This can be used to load modules from custom sources Or provide custom resolution logic or caching

pub fn with_startup_snapshot(self, snapshot: &'static [u8]) -> Self

Set the startup snapshot for the runtime This will reduce load times, but requires the same extensions to be loaded as when the snapshot was created If provided, user-supplied extensions must be instantiated with init_ops instead of init_ops_and_esm

WARNING: Snapshots MUST be used on the same system they were created on

pub fn with_isolate_params(self, params: CreateParams) -> Self

Set the params used to create the underlying V8 isolate This can be used to alter the behavior of the runtime. See the rusty_v8 documentation for more information

pub fn with_shared_array_buffer_store( self, store: SharedArrayBufferStore, ) -> Self

Set the shared array buffer store to use for the runtime Allows data-sharing between runtimes across threads

pub fn with_cryto_seed(self, seed: u64) -> Self

Set the initial seed for the crypto extension

pub fn build(self) -> Result<Runtime, Error>

Consume the builder and create a new runtime with the given options

Errors

Will return an error if the runtime cannot be created (usually an issue with extensions)

Trait Implementations

impl Default for RuntimeBuilder

fn default() -> Self

Returns the “default value” for a type.