Struct perseus::state::PageStateStore

pub struct PageStateStore { /* private fields */ }

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.

Note that the same pages in different locales will have different entries here. If you need to store state for a page across locales, you should use the global state system instead. For apps not using i18n, the page URL will not include any locale.

Implementations

impl PageStateStore

pub fn get<T: AnyFreeze + Clone>(&self, url: &str) -> Option<T>

Gets an element out of the state by its type and URL. If the element stored for the given URL doesn’t match the provided type, None will be returned.

pub fn add<T: AnyFreeze + Clone>(&mut self, url: &str, val: T)

Adds a new element to the state by its URL. Any existing element with the same URL will be silently overriden (use .contains() to check first if needed).

pub fn contains(&self, url: &str) -> bool

Checks if the state contains an entry for the given URL.

impl PageStateStore

pub fn freeze_to_hash_map(&self) -> HashMap<String, String>

Freezes the component entries into a new HashMap of Strings to avoid extra layers of deserialization.

Trait Implementations

impl Clone for PageStateStore

fn clone(&self) -> PageStateStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageStateStore

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

Formats the value using the given formatter.

impl Default for PageStateStore

fn default() -> PageStateStore

Returns the “default value” for a type.