Struct dioxus_fullstack::prelude::DioxusServerContext

pub struct DioxusServerContext { /* private fields */ }

Available on crate feature server only.

A shared context for server functions that contains information about the request and middleware state. This allows you to pass data between your server framework and the server functions. This can be used to pass request information or information about the state of the server. For example, you could pass authentication data though this context to your server functions.

You should not construct this directly inside components. Instead use the HasServerContext trait to get the server context from the scope.

Implementations

impl DioxusServerContext

pub fn new(parts: Parts) -> Self

Create a new server context from a request

pub fn get<T: Any + Send + Sync + Clone + 'static>(&self) -> Option<T>

Clone a value from the shared server context

pub fn insert<T: Any + Send + Sync + 'static>(&self, value: T)

Insert a value into the shared server context

pub fn insert_any(&self, value: Box<dyn Any + Send + Sync>)

Insert a Boxed Any value into the shared server context

pub fn response_parts(&self) -> RwLockReadGuard<'_, Parts>

Get the response parts from the server context

pub fn response_parts_mut(&self) -> RwLockWriteGuard<'_, Parts>

Get the response parts from the server context

pub fn request_parts(&self) -> RwLockReadGuard<'_, Parts>

Get the request that triggered:

• The initial SSR render if called from a ScopeState or ServerFn
• The server function to be called if called from a server function after the initial render

pub fn request_parts_mut(&self) -> RwLockWriteGuard<'_, Parts>

Get the request that triggered:

• The initial SSR render if called from a ScopeState or ServerFn
• The server function to be called if called from a server function after the initial render

pub async fn extract<R: Error, T: FromServerContext<Rejection = R>>( &self, ) -> Result<T, R>

Extract some part from the request

Trait Implementations

impl Clone for DioxusServerContext

fn clone(&self) -> DioxusServerContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for DioxusServerContext

fn default() -> Self

Returns the “default value” for a type.