Struct StreamingContext 

pub struct StreamingContext { /* private fields */ }

The context dioxus fullstack provides for the status of streaming responses on the server

Implementations

impl StreamingContext

pub fn new(parts: Parts) -> Self

Create a new streaming context. You should not need to call this directly. Dioxus fullstack will provide this context for you.

pub fn commit_initial_chunk(&mut self)

Commit the initial chunk of the response. This will be called automatically if you are using the dioxus router when the suspense boundary above the router is resolved. Otherwise, you will need to call this manually to start the streaming part of the response.

Once this method has been called, the http response parts can no longer be modified.

pub fn current_status(&self) -> StreamingStatus

Get the current status of the streaming response. This method is reactive and will cause the current reactive context to rerun when the status changes.

pub fn parts_mut(&self) -> RefMut<'_, Parts>

Access the http request parts mutably. This will allow you to modify headers and other parts of the request.

pub async fn extract<T: FromRequest<(), M>, M>() -> Result<T, ServerFnError>

Extract an axum extractor from the current request. This will always use an empty body for the request, since it’s assumed that rendering the app is done under a GET request.

pub fn current() -> Option<Self>

Get the current StreamingContext if it exists. This will return None if called on the client or outside of a streaming response on the server.

Trait Implementations

impl Clone for StreamingContext

fn clone(&self) -> StreamingContext

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamingContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StreamingContext

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.