Struct subscript::program_sys::shell::Shell

pub struct Shell<S: Spec> { /* fields omitted */ }

It’s a reincarnated-bourne-again shell for your everyday web-app needs. :)

User-level commands are exposed or rather implemented as methods on the Shell type (so from your docs navigate to “methods” section).

Methods

impl<S: Spec + 'static> Shell<S>

pub fn broadcast(&mut self, msg: impl Any)

Heterogeneous value broadcasting system.

// lets broadcast some random messages (values) of different types
sh.broadcast(SomeType(...));
sh.broadcast(SomeOtherType(...));
sh.broadcast(UrlRequest(Page::Something));

pub fn message<T: Spec + 'static, V: Any>(&mut self, msg: V)

Heterogeneous "component-to-component" value messaging system.

// This is perhaps impossible without types hehe
sh.message::<SomeComponentType>(message_value);
///         ^^^^^^^^^^^^^^^^^^^ sent a message to any component of the given type.

pub fn navigate(&mut self, path: impl UrlString)

Update the browser’s URL (i.e. for SPAs).

sh.navigate("/account");

pub fn current_url(&self) -> Url

Returns the current URL.

pub fn cache(&self) -> Cache

Caching support.

pub fn http_client(&self) -> &HttpClient<S>

Make http requests (e.g. for interacting with backend API services).