Struct perseus::state::GlobalStateCreator

pub struct GlobalStateCreator { /* private fields */ }

A creator for global state. This stores user-provided functions that will be invoked to generate global state on the client and the server.

The primary purpose of this is to allow the generation of top-level app state on the server and the client. Notably, this can also be interacted with by plugins.

Implementations

impl GlobalStateCreator

pub fn new() -> Self

Creates a new instance of this struct.

pub fn build_state_fn<S, V>( self, val: impl GlobalStateBuildUserFnType<S, V> + Clone + Send + Sync + 'static ) -> Selfwhere S: Serialize + DeserializeOwned + MakeRx, V: Into<GeneratorResult<S>>,

Adds a function to generate global state at build-time.

pub fn build_state_fn(self, _val: impl Fn() + 'static) -> Self

Adds a function to generate global state at build-time.

pub fn request_state_fn<S, V>( self, val: impl GlobalStateRequestUserFnType<S, V> + Clone + Send + Sync + 'static ) -> Selfwhere S: Serialize + DeserializeOwned + MakeRx, V: Into<BlamedGeneratorResult<S>>,

Adds a function to generate global state at request-time.

pub fn request_state_fn(self, _val: impl Fn() + 'static) -> Self

Adds a function to generate global state at request-time.

pub fn amalgamate_states_fn<S, V>( self, val: impl GlobalStateAmalgamationUserFnType<S, V> + Clone + Send + Sync + 'static ) -> Selfwhere S: Serialize + DeserializeOwned + MakeRx + Send + Sync + 'static, V: Into<BlamedGeneratorResult<S>>,

Adds a function to amalgamate build-time and request-time global state.

pub fn amalgamate_states_fn(self, _val: impl Fn() + 'static) -> Self

Adds a function to amalgamate build-time and request-time global state.

pub async fn get_build_state(&self) -> Result<TemplateState, ServerError>

Gets the global state at build-time.

pub async fn get_request_state( &self, req: Request ) -> Result<TemplateState, ServerError>

Gets the global state at request-time.

pub async fn amalgamate_states( &self, build_state: TemplateState, request_state: TemplateState ) -> Result<TemplateState, ServerError>

Amalgamates global state that was generated at build-time with that generated at request-time, according to custom user-provided logic.

pub fn uses_request_state(&self) -> bool

Checks if this state needs to do anything on requests for it.

pub fn uses_build_state(&self) -> bool

Checks if this state needs to do anything at build time.

pub fn can_amalgamate_states(&self) -> bool

Checks if this state has custom logic to amalgamate build and request states if both are generated.

Trait Implementations

impl Debug for GlobalStateCreator

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

Formats the value using the given formatter.

impl Default for GlobalStateCreator

fn default() -> GlobalStateCreator

Returns the “default value” for a type.