Struct StreamingSession 

pub struct StreamingSession { /* private fields */ }

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

Every method returns the bytes it produced. Write them to the response and await drain whenever write() returns false; the session holds no transport and never blocks on one.

const session = protocol.streamResponse('index.html', '/');
const weather = session.boundary('weather-shell');
res.write(session.writeShell(shellState));
res.write(session.writeBoundary(weather, weatherState, 'updatable'));
res.write(session.update(weather, forecast));
res.end(session.finish(tailState));

Implementations

impl StreamingSession

pub fn boundary(&self, name: String) -> Result<u32>

Resolve an authored boundary name to a stable integer handle.

Resolve once outside the write loop; the handle costs nothing to reuse.

pub fn boundary_count(&self) -> u32

Number of compile-time boundaries declared by this entry.

pub fn finished(&self) -> bool

Whether the terminal record has been written.

pub fn write_shell(&mut self, state_json: String) -> Result<Buffer>

Render everything before the first boundary.

pub fn write_boundary( &mut self, boundary: u32, state_json: String, mode: Option<String>, ) -> Result<Buffer>

Render and commit the next boundary in declaration order.

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

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

Push a projected state patch to a committed updatable boundary.

pub fn finish(&mut self, state_json: String) -> Result<Buffer>

Render the document tail and emit the terminal record.

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 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.