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(
    self,
    val: impl GlobalStateCreatorFnType + Send + Sync + 'static
) -> Self

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

pub async fn get_build_state(&self) -> Result<Option<String>, GlobalStateError>

Gets the global state at build-time. If no function was registered to this, we’ll return None.

Trait Implementations

impl Clone for GlobalStateCreator

fn clone(&self) -> GlobalStateCreator

Returns a copy of the value.

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

Performs copy-assignment from source.

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.