Skip to main content

StreamingResponse

Struct StreamingResponse 

Source
pub struct StreamingResponse<'a, W>
where W: FlushWriter + ?Sized,
{ /* private fields */ }
Expand description

A host-controlled progressive HTML response.

Each method synchronously borrows only the state value supplied to that call. The host may await backend work between calls while this response retains renderer inventory, transport backpressure, and hydration metadata.

Implementations§

Source§

impl<'a, W> StreamingResponse<'a, W>
where W: FlushWriter + ?Sized,

Source

pub fn boundary(&self, name: &str) -> Result<BoundaryId, HandlerError>

Resolve a free-form authored name to an integer response handle.

§Errors

Returns an actionable error with valid names and a typo suggestion when the entry does not declare name.

Source

pub fn boundary_count(&self) -> usize

Number of compile-time boundaries in this entry.

Source

pub fn write_shell(&mut self, state: &Value) -> Result<(), HandlerError>

Render and flush the document prefix before the first boundary.

Source

pub fn write_boundary( &mut self, boundary: BoundaryId, state: &Value, mode: BoundaryMode, ) -> Result<(), HandlerError>

Render, commit, and flush the next compile-time boundary.

Source

pub fn update( &mut self, boundary: BoundaryId, state: &Value, ) -> Result<(), HandlerError>

Push a projected state patch to an already committed updatable boundary.

Source

pub fn finish(self, state: &Value) -> Result<(), HandlerError>

Render the document tail, emit the terminal record, and end the writer.

Auto Trait Implementations§

§

impl<'a, W> !RefUnwindSafe for StreamingResponse<'a, W>

§

impl<'a, W> !Send for StreamingResponse<'a, W>

§

impl<'a, W> !Sync for StreamingResponse<'a, W>

§

impl<'a, W> !UnwindSafe for StreamingResponse<'a, W>

§

impl<'a, W> Freeze for StreamingResponse<'a, W>
where W: ?Sized,

§

impl<'a, W> Unpin for StreamingResponse<'a, W>
where W: ?Sized,

§

impl<'a, W> UnsafeUnpin for StreamingResponse<'a, W>
where W: ?Sized,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.