Struct rquickjs_core::Runtime

#[repr(transparent)]
pub struct Runtime { /* private fields */ }

Quickjs runtime, entry point of the library.

Implementations

impl Runtime

pub fn idle(&self) -> Idle

Available on crate feature futures only.

Await until all pending jobs and spawned futures will be done

pub fn run_executor(&self) -> Executor

Available on crate feature futures only.

Run pending jobs and futures executor

pub fn spawn_executor<A: ExecutorSpawner>(&self, spawner: A) -> A::JoinHandle

Available on crate feature futures only.

Spawn pending jobs and futures executor

pub fn spawn<F, T>(&self, future: F) where
    F: Future<Output = T> + ParallelSend + 'static,
    T: ParallelSend + 'static, 

Available on crate feature futures only.

Spawn future using runtime

impl Runtime

pub fn new() -> Result<Self>

Create a new runtime.

Will generally only fail if not enough memory was available.

Features

If the "rust-alloc" feature is enabled the Rust’s global allocator will be used in favor of libc’s one.

pub fn new_with_alloc<A>(allocator: A) -> Result<Self> where
    A: Allocator + 'static, 

Available on crate feature allocator only.

Create a new runtime using specified allocator

Will generally only fail if not enough memory was available.

pub fn weak(&self) -> WeakRuntime

Get weak ref to runtime

pub fn set_interrupt_handler(
    &self,
    handler: Option<Box<dyn FnMut() -> bool + 'static>>
)

Set a closure which is regularly called by the engine when it is executing code. If the provided closure returns true the interpreter will raise and uncatchable exception and return control flow to the caller.

pub fn set_loader<R, L>(&self, resolver: R, loader: L) where
    R: Resolver + 'static,
    L: Loader + 'static, 

Available on crate feature loader only.

Set the module loader

pub fn set_info<S: Into<Vec<u8>>>(&self, info: S) -> Result<()>

Set the info of the runtime

pub fn set_memory_limit(&self, limit: usize)

Set a limit on the max amount of memory the runtime will use.

Setting the limit to 0 is equivalent to unlimited memory.

Note that is a Noop when a custom allocator is being used, as is the case for the “rust-alloc” or “allocator” features.

pub fn set_max_stack_size(&self, limit: usize)

Set a limit on the max size of stack the runtime will use.

The default values is 256x1024 bytes.

pub fn set_gc_threshold(&self, threshold: usize)

Set a memory threshold for garbage collection.

pub fn run_gc(&self)

Manually run the garbage collection.

Most of quickjs values are reference counted and will automaticly free themselfs when they have no more references. The garbage collector is only for collecting cyclic references.

pub fn memory_usage(&self) -> MemoryUsage

Get memory usage stats

pub fn is_job_pending(&self) -> bool

Test for pending jobs

Returns true when at least one job is pending.

pub fn execute_pending_job(&self) -> Result<bool>

Execute first pending job

Returns true when job was executed or false when queue is empty or error when exception thrown under execution.

Trait Implementations

impl Clone for Runtime

fn clone(&self) -> Runtime

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.