Struct Ssr

pub struct Ssr<'s, 'i> { /* private fields */ }

This struct holds all the necessary v8 utilities to execute Javascript code. It cannot be shared across threads.

Implementations

impl<'s, 'i> Ssr<'s, 'i>

where 's: 'i,

pub fn create_platform()

Initialize a V8 js engine instance. It’s mandatory to call it before any call to V8. The Ssr module needs this function call before any other operation. It cannot be called more than once per process.

pub fn from(source: String, entry_point: &str) -> Result<Ssr<'s, 'i>, SsrError>

It creates a new SSR instance (multiple instances are allowed).

This function is expensive and it should be called as less as possible.

Even though V8 allows multiple threads the Ssr struct created with this call can be accessed by just the thread that created it.

Entry point is the JS element that the bundler exposes. It has to be an empty string in case the bundle is exported as IIFE.

Check the examples vite-react (for the IIFE example) and webpack-react (for the bundle exported as variable).

See the examples folder for more about using multiple parallel instances for multi-threaded execution.

pub fn add_global_fn( &self, name: &'static str, callback: impl MapFnTo<extern "C" fn(_: *const FunctionCallbackInfo)>, ) -> Result<(), SsrError>

Add a global function to the V8 runtime. Any function defined here can be executed within any js scope

pub fn render_to_string( &mut self, params: Option<&str>, ) -> Result<String, SsrError>

Execute the Javascript functions and return the result as string.

Trait Implementations

impl<'s, 'i> Debug for Ssr<'s, 'i>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for Ssr<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.