Struct StreamingSession 

pub struct StreamingSession { /* private fields */ }

A progressive response owned independently of any Rust borrow.

Exposes the same step machine as super::StreamingResponse: Self::start writes the shell prefix, Self::resume writes exactly one occurrence through its checkpoint, and Self::advance writes the parent bytes that follow it.

Implementations

impl StreamingSession

pub fn new( handler: Arc<WebUIHandler>, protocol: Arc<Protocol>, options: SessionOptions, ) -> Result<StreamingSession, HandlerError>

Create an unstarted owned session.

pub fn start<'state>( &mut self, state: impl Into<StreamingState<'state>>, ) -> Result<StreamStep, HandlerError>

Render until the first runtime boundary occurrence or terminal.

Pass an owned Value to move it into the continuation, or a reference to retain caller ownership and clone only the required projection.

pub fn resume<'state>( &mut self, instance_id: BoundaryInstanceId, state: impl Into<StreamingState<'state>>, mode: BoundaryMode, ) -> Result<StreamStep, HandlerError>

Commit the pending occurrence through its checkpoint, then stop.

The returned bytes hold that occurrence’s record and nothing that follows it. Call Self::advance for the parent bytes.

BoundaryMode::Updatable is refused once the response has committed as many updatable occurrences as the browser retains. The refusal produces no bytes and leaves the occurrence pending, so it can be committed with BoundaryMode::Final instead. Pass an owned Value to move changed subtrees, or a reference to retain caller ownership. Equal values preserve the prior state-reference base. Use Self::resume_current when no state changed.

pub fn resume_current( &mut self, instance_id: BoundaryInstanceId, mode: BoundaryMode, ) -> Result<StreamStep, HandlerError>

Commit the pending occurrence against the session’s retained state.

The call still returns immediately after the checkpoint flush, preserving the host’s async pause point before Self::advance, but avoids a state overlay when no data changed since the preceding step.

pub fn advance(&mut self) -> Result<StreamStep, HandlerError>

Write the ordinary parent bytes that follow a committed occurrence.

Valid only after Self::resume.

pub fn update( &mut self, instance_id: BoundaryInstanceId, patch: &Value, ) -> Result<Vec<u8>, HandlerError>

Emit an update for one committed updatable runtime occurrence.

Valid between Self::resume and Self::advance, so a host can revise the occurrence it just committed while the response stays open.

pub fn is_done(&self) -> bool

Whether terminal emission completed.