Struct Shell 

pub struct Shell { /* private fields */ }

The chrome shared by every authenticated page: the top-nav links and the signed-in operator. Built once by the auth guard and injected into request extensions, so page handlers render inside the same shell without each rebuilding it. Templates embed it as shell and base.html renders it.

A contributed screen takes it as Extension<Shell> and renders its own markup inside the chrome with Shell::page; Shell::t localizes its strings and Shell::csrf_token arms a form it builds by hand.

Implementations

impl Shell

pub fn icon(&self, name: &str) -> String

Inline SVG for a named icon from the framework’s set, for a template’s own chrome ({{ shell.icon("folder")|safe }}). An unknown name renders the missing mark.

pub fn t(&self, source: &str) -> String

Localizes a source string in this request’s locale, falling back to the source itself. Templates call {{ shell.t("Save") }}.

pub fn tt(&self, text: &Text) -> String

Localizes a prebuilt message (a t!/tn! value, a descriptor label, a flash) into this request’s locale.

pub fn i18n(&self) -> &Translator

The request’s translator, for a field type that localizes strings of its own (a repeater’s sub-field labels) rather than only the label it is given.

pub fn locale(&self) -> &str

The active locale (most specific in the chain), for <html lang>.

pub fn base(&self) -> &str

The admin mount (/admin), for a link into the panel.

pub fn csrf_token(&self) -> &str

This session’s request token, for a form a screen builds by hand: a hidden field named _csrf, placed first when the form uploads a file. An HTMX request carries it already.

pub fn datetime(&self, utc: &str) -> String

A UTC timestamp as stored (RFC 3339), shown in this operator’s timezone. Text that does not parse is shown as it is.

pub fn page(&self, title: &Text, body: Markup) -> Response

Renders body as a page in the admin chrome, headed by title. The body is a screen’s own markup, built from its templates through html::Markup::from_template.

pub fn page_with(&self, head: PageHead, body: Markup) -> Response

A contributed page with a PageHead: the title, a way back and the actions beside it, then body inside the chrome.

pub fn tf(&self, source: &str, args: &[(&'static str, i64)]) -> String

Localizes a source string with integer {name} arguments, for a template ({{ shell.tf("Page {n} of {m}", [("n", page), ("m", pages)]) }}). Nested-Text arguments are built in Rust with t! and rendered with tt.

pub fn tfs(&self, source: &str, args: &[(&'static str, &str)]) -> String

Like Shell::tf, but with string {name} arguments, for a template ({{ shell.tfs("Signed in as {name}", [("name", user)]) }}).

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.