Module perseus::state

Utilities for working with Perseus’ state platform.

Structs

FrozenApp

A representation of a frozen app.

GlobalState

A representation of the global state in an app.

GlobalStateCreator

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

IdbFrozenStateStore

A frozen state store that uses IndexedDB as a backend. This will only store a single frozen state at a time, removing all previously stored states every time a new one is set.

PageStateStore

A container for page state in Perseus. This is designed as a context store, in which one of each type can be stored. Therefore, it acts very similarly to Sycamore’s context system, though it’s specifically designed for each page to store one reactive properties object. In theory, you could interact with this entirely independently of Perseus’ state interface, though this isn’t recommended.

ThawPrefs

The user’s preferences on state thawing.

Enums

IdbError

PageThawPrefs

The user’s preferences on page state thawing. Templates have three places they can fetch state from: the page state store (called active state), the frozen state, and the server. They’re typically prioritized in that order, but if thawing occurs later in an app, it may be desirable to override active state in favor of frozen state. These preferences allow setting an inclusion or exclusion list.

Traits

AnyFreeze

A convenience super-trait for Freezeable things that can be downcast to concrete types.

Freeze

A trait for reactive structs that can be made unreactive and serialized to a String. structs that implement this should implement MakeUnrx for simplicity, but they technically don’t have to (they always do in Perseus macro-generated code).

MakeRx

A trait for structs that can be made reactive. Typically, this will be derived with the #[make_rx] macro, though it can be implemented manually if you have more niche requirements.

MakeUnrx

A trait for reactive structs that can be made un-reactive. This is the opposite of MakeRx, and is intended particularly for state freezing. Like MakeRx, this will usually be derived automatically with the #[make_rx] macro, but you can also implement it manually.

Functions

force_reload

Force-reloads the page. Any code after this will NOT be called, as the browser will completely reload the page, dumping your code and restarting from the beginning. This will result in a total loss of all state unless it’s frozen in some way.

hsr_freeze

Freezes the app’s state to IndexedDB to be accessed in future.

hsr_thaw

Thaws a previous state frozen in development.