Skip to main content

JsRuntime

Struct JsRuntime 

Source
pub struct JsRuntime { /* private fields */ }
Expand description

This is the main entry point for the library. It manages the QuickJS runtime, as well as the registered handlers and host modules.

Implementations§

Source§

impl JsRuntime

Source

pub fn new<H: Host + 'static>(host: H) -> Result<Self>

Create a new JsRuntime with the given host. The resulting runtime will have global objects registered.

Source

pub fn register_json_host_function( &mut self, module_name: impl Into<String>, function_name: impl Into<String>, function: impl Fn(String) -> Result<String> + 'static, ) -> Result<()>

Register a host function in the specified module. The function takes and returns a JSON string, which is deserialized and serialized by the runtime. The arguments are serialized as a JSON array containing all the arguments passed to the function.

Source

pub fn register_host_function<Args, Output>( &mut self, module_name: impl Into<String>, function_name: impl Into<String>, function: impl Fn<Args, Output = Result<Output>> + 'static, ) -> Result<()>
where Args: DeserializeOwned, Output: Serialize,

Register a host function in the specified module. The function takes and returns any type that can be (de)serialized by serde.

Source

pub fn register_handler( &mut self, function_name: impl Into<String>, handler_script: impl Into<String>, handler_pwd: impl Into<String>, ) -> Result<()>

Register a handler function with the runtime. The handler script is a JavaScript module that exports a function named handler. The handler function takes a single argument, which is the event data deserialized from a JSON string.

Source

pub fn run_handler( &mut self, function_name: String, event: String, run_gc: bool, ) -> Result<String>

Run a registered handler function with the given event data. The event data is passed as a JSON string, and the handler function is expected to return a value that can be serialized to JSON. The result is returned as a JSON string. If run_gc is true, the runtime will run a garbage collection cycle after running the handler.

Trait Implementations§

Source§

impl Drop for JsRuntime

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for JsRuntime

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ParallelSend for T