Struct Protocol 

pub struct Protocol { /* private fields */ }

A decoded protocol and its reusable deterministic indices.

Create this once when a Node server loads protocol.bin, then reuse it for full renders, partial navigation, component loading, and token queries. The selected hydration plugin is bound once at construction.

Implementations

impl Protocol

pub fn new(protocol_data: Buffer, plugin: Option<String>) -> Result<Self>

Decode a protocol and bind its render plugin for repeated rendering.

pub fn render( &self, state_json: String, entry: String, request_path: String, ) -> Result<Buffer>

Render from an existing JSON string into a UTF-8 Node.js buffer.

pub fn prepare_state(&self, state_json: String) -> Result<External<Value>>

Parse and retain an immutable, process-local state snapshot.

The returned N-API external owns the parsed state until its JavaScript handle is garbage-collected.

pub fn render_prepared( &self, state: &External<Value>, entry: String, request_path: String, ) -> Result<Buffer>

Render an immutable state snapshot prepared by this process.

pub fn render_stream( &self, state_json: String, entry: String, request_path: String, on_chunk: Function<'_, String>, ) -> Result<()>

Stream an existing JSON string in bounded chunks.

pub fn render_partial( &self, state_json: String, entry_id: String, request_path: String, inventory_hex: String, ) -> Result<String>

Produce a complete partial-navigation response.

pub fn render_component_templates( &self, component_tags: Vec<String>, inventory_hex: String, ) -> Result<String>

Render component templates and styles for on-demand loading.

pub fn tokens(&self) -> Vec<String>

Return CSS token names in build order.

pub fn stream_response( &self, entry: String, request_path: String, options: Option<JsStreamOptions>, ) -> Result<StreamingSession>

Open a host-driven progressive response for a streaming entry.

Unlike renderStream, which pushes every chunk during one synchronous call, the returned session hands each chunk back so the Node server owns the socket, the write order, and backpressure.

Trait Implementations

impl FromNapiMutRef for Protocol

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

This function called to convert napi values to native rust values

impl FromNapiRef for Protocol

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

This function called to convert napi values to native rust values

impl JavaScriptClassExt for Protocol

fn into_instance<'scope>( self, env: &'scope Env, ) -> Result<ClassInstance<'scope, Self>>

fn into_reference(self, env: Env) -> Result<Reference<Self>>

fn instance_of<'env, V: JsValue<'env>>(env: &Env, value: &V) -> Result<bool>

impl ObjectFinalize for Protocol

fn finalize(self, env: Env) -> Result<(), Error>

impl ToNapiValue for Protocol

unsafe fn to_napi_value(env: napi_env, val: Protocol) -> Result<napi_value>

This function called to convert rust values to napi values

fn into_unknown(self, env: &Env) -> Result<Unknown<'_>, Error>

impl TypeName for Protocol

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &Protocol

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &mut Protocol

fn type_name() -> &'static str

fn value_type() -> ValueType

impl ValidateNapiValue for &Protocol

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

This function called to validate whether napi value passed to rust is valid type.

impl ValidateNapiValue for &mut Protocol

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

This function called to validate whether napi value passed to rust is valid type.