Struct StreamingSession 

pub struct StreamingSession { /* private fields */ }

A progressive HTML response driven one semantic step at a time from Node.

start(), resume(), and advance() return bytes, completion state, and the next runtime boundary occurrence (if any). Boundary keys retain their authored JSON type: strings are JavaScript strings and finite numbers are JavaScript numbers.

const session = protocol.streamResponse('index.html', '/');
let step = session.start(JSON.stringify(shellState));
res.write(step.bytes);
while (!step.done) {
  const { instanceId, name, key } = step.boundary;
  const state = await loadBoundary(name, key);
  step = session.resume(instanceId, JSON.stringify(state), 'updatable');
  res.write(step.bytes);
  step = session.advance();
  res.write(step.bytes);
}

Implementations

impl StreamingSession

pub fn start(&mut self, state_json: String) -> Result<JsStreamStep>

Render until the first runtime boundary occurrence or terminal.

pub fn resume( &mut self, instance_id: u32, state_json: String, mode: Option<String>, ) -> Result<JsStreamStep>

Commit the pending occurrence through its checkpoint, then stop.

mode is "final" (default) or "updatable". Only updatable boundaries accept later update() calls.

pub fn advance(&mut self) -> Result<JsStreamStep>

Write the parent bytes after the committed occurrence.

Valid only after resume(). Returns the next boundary occurrence or completes the document tail.

pub fn update(&mut self, instance_id: u32, patch_json: String) -> Result<Buffer>

Push a projected state patch to a committed updatable boundary.

Trait Implementations

impl FromNapiMutRef for StreamingSession

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 StreamingSession

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 StreamingSession

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 StreamingSession

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

impl ToNapiValue for StreamingSession

unsafe fn to_napi_value( env: napi_env, val: StreamingSession, ) -> 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 StreamingSession

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &StreamingSession

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &mut StreamingSession

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeTag for StreamingSession

fn type_tag() -> napi_type_tag

Returns this class’s stable per-type tag. The derive computes it from the class’s content identity string (crate@version::module_path::ClassName), which is fixed for a given class, so repeated calls return the same tag.

impl ValidateNapiValue for &StreamingSession

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 StreamingSession

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.