Struct RuntimeBuilder

Source

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

Expand description

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§

Source §

impl RuntimeBuilder

Source

pub fn new() -> Self

Create a new runtime builder with default options

Source

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

Source

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

Source

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

Source

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

Source

pub fn with_max_heap_size(self, max_heap_size: usize) -> Self

Optional maximum heap size for the runtime

Source

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

Optional import provider for the module loader

Source

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

Source

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

Source

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

Source

pub fn with_schema(self, schema: impl ToString) -> Self

Add to a whitelist of custom schema prefixes that are allowed to be loaded from javascript

By default only http/https (url_import crate feature), and file (fs_import crate feature) are allowed

Source

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

Available on crate feature crypto only.

Set the initial seed for the crypto extension

Source

pub fn with_io_pipes(self, pipes: Stdio) -> Self

Available on crate feature io only.

Set the options for the io extension

Source

pub fn with_webstorage_origin_storage_dir(self, dir: PathBuf) -> Self

Available on crate feature webstorage only.

Set the options for the webstorage extension

Source

pub fn with_cache(self, cache: CreateCache<CacheBackend>) -> Self

Available on crate feature cache only.

Set the options for the cache extension

Source

pub fn with_broadcast_channel(self, channel: InMemoryBroadcastChannel) -> Self

Available on crate feature broadcast_channel only.

Set the options for the broadcast channel extension

Source

pub fn with_kv_store(self, kv_store: KvStore) -> Self

Available on crate feature kv only.

Set the options for the kv store extension

Source

pub fn with_node_resolver(self, resolver: Arc<RustyResolver>) -> Self

Available on crate feature node_experimental only.

Set the options for the node extension

Source