Skip to main content

AppShell

Struct AppShell 

Source
pub struct AppShell<'a> {
Show 24 fields pub title: &'a str, pub app_name: &'a str, pub mode: &'a str, pub html_attrs: &'a [HtmlAttr<'a>], pub mode_locked: bool, pub density_class: &'a str, pub asset_base_path: &'a str, pub brand_href: Option<&'a str>, pub head_html: Option<TrustedHtml<'a>>, pub nav_html: &'a str, pub nav_aria_label: &'a str, pub breadcrumbs_html: Option<TrustedHtml<'a>>, pub topbar_html: Option<TrustedHtml<'a>>, pub page_header_html: Option<TrustedHtml<'a>>, pub actions_html: &'a str, pub content_html: &'a str, pub main_class: &'a str, pub profile: Option<SidebarProfile<'a>>, pub status_left: &'a str, pub status_right: &'a str, pub footer_html: Option<TrustedHtml<'a>>, pub include_htmx_sse: bool, pub scripts_html: Option<TrustedHtml<'a>>, pub body_hx_boost: bool,
}

Fields§

§title: &'a str§app_name: &'a str§mode: &'a str§html_attrs: &'a [HtmlAttr<'a>]§mode_locked: bool§density_class: &'a str§asset_base_path: &'a str§brand_href: Option<&'a str>§head_html: Option<TrustedHtml<'a>>§nav_html: &'a str§nav_aria_label: &'a str§breadcrumbs_html: Option<TrustedHtml<'a>>§topbar_html: Option<TrustedHtml<'a>>§page_header_html: Option<TrustedHtml<'a>>§actions_html: &'a str§content_html: &'a str§main_class: &'a str§profile: Option<SidebarProfile<'a>>§status_left: &'a str§status_right: &'a str§footer_html: Option<TrustedHtml<'a>>§include_htmx_sse: bool§scripts_html: Option<TrustedHtml<'a>>§body_hx_boost: bool

Implementations§

Source§

impl<'a> AppShell<'a>

Source

pub const fn new( title: &'a str, app_name: &'a str, content_html: &'a str, ) -> Self

Source

pub const fn with_mode(self, mode: &'a str) -> Self

Source

pub const fn with_html_attrs(self, html_attrs: &'a [HtmlAttr<'a>]) -> Self

Source

pub const fn mode_locked(self) -> Self

Source

pub const fn light(self) -> Self

Source

pub const fn dark(self) -> Self

Source

pub const fn dense(self) -> Self

Source

pub const fn default_density(self) -> Self

Source

pub const fn with_asset_base_path(self, asset_base_path: &'a str) -> Self

Source

pub const fn with_brand_href(self, brand_href: &'a str) -> Self

Source

pub const fn with_head(self, head_html: TrustedHtml<'a>) -> Self

Source

pub const fn with_nav(self, nav_html: &'a str) -> Self

Source

pub const fn with_nav_aria_label(self, nav_aria_label: &'a str) -> Self

Source

pub const fn with_breadcrumbs(self, breadcrumbs_html: TrustedHtml<'a>) -> Self

Source

pub const fn with_topbar(self, topbar_html: TrustedHtml<'a>) -> Self

Source

pub const fn with_page_header(self, page_header_html: TrustedHtml<'a>) -> Self

Source

pub const fn with_actions(self, actions_html: &'a str) -> Self

Source

pub const fn with_main_class(self, main_class: &'a str) -> Self

Source

pub const fn with_profile(self, profile: SidebarProfile<'a>) -> Self

Source

pub const fn with_status( self, status_left: &'a str, status_right: &'a str, ) -> Self

Source

pub const fn with_htmx_sse(self) -> Self

Source

pub const fn with_scripts(self, scripts_html: TrustedHtml<'a>) -> Self

Source

pub const fn with_body_hx_boost(self, body_hx_boost: bool) -> Self

Source

pub const fn without_body_hx_boost(self) -> Self

Source

pub fn main_class_name(&self) -> String

Trait Implementations§

Source§

impl<'a> Debug for AppShell<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Display for AppShell<'a>

Implement the format!() trait for AppShell

Please be aware of the rendering performance notice in the Template trait.

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> FastWritable for AppShell<'a>

Source§

fn write_into(&self, dest: &mut dyn Write, values: &dyn Values) -> Result<()>

Used internally by askama to speed up writing some types.
Source§

impl<'a> Template for AppShell<'a>

Source§

const SIZE_HINT: usize = 805usize

Provides a rough estimate of the expanded length of the rendered template. Larger values result in higher memory usage but fewer reallocations. Smaller values result in the opposite. This value only affects render. It does not take effect when calling render_into, write_into, the fmt::Display implementation, or the blanket ToString::to_string implementation.
Source§

fn render_into_with_values( &self, __askama_writer: &mut dyn Write, __askama_values: &dyn Values, ) -> Result<()>

Renders the template to the given writer fmt buffer with provided Values. Read more
Source§

fn render(&self) -> Result<String, Error>

Helper method which allocates a new String and renders into it. Read more
Source§

fn render_with_values(&self, values: &dyn Values) -> Result<String, Error>

Helper method which allocates a new String and renders into it with provided Values. Read more
Source§

fn render_into(&self, writer: &mut dyn Write) -> Result<(), Error>

Renders the template to the given writer fmt buffer. Read more
Source§

fn write_into(&self, writer: &mut dyn Write) -> Result<(), Error>

Renders the template to the given writer io buffer. Read more
Source§

fn write_into_with_values( &self, writer: &mut dyn Write, values: &dyn Values, ) -> Result<(), Error>

Renders the template to the given writer io buffer with provided Values. Read more
Source§

impl<'a> HtmlSafe for AppShell<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for AppShell<'a>

§

impl<'a> RefUnwindSafe for AppShell<'a>

§

impl<'a> Send for AppShell<'a>

§

impl<'a> Sync for AppShell<'a>

§

impl<'a> Unpin for AppShell<'a>

§

impl<'a> UnsafeUnpin for AppShell<'a>

§

impl<'a> UnwindSafe for AppShell<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DynTemplate for T
where T: Template,

Source§

fn dyn_render(&self) -> Result<String, Error>

Helper method which allocates a new String and renders into it.
Source§

fn dyn_render_with_values(&self, values: &dyn Values) -> Result<String, Error>

Helper method which allocates a new String and renders into it with provided Values.
Source§

fn dyn_render_into(&self, writer: &mut dyn Write) -> Result<(), Error>

Renders the template to the given writer fmt buffer.
Source§

fn dyn_render_into_with_values( &self, writer: &mut dyn Write, values: &dyn Values, ) -> Result<(), Error>

Renders the template to the given writer fmt buffer with provided Values.
Source§

fn dyn_write_into(&self, writer: &mut dyn Write) -> Result<(), Error>

Renders the template to the given writer io buffer.
Source§

fn dyn_write_into_with_values( &self, writer: &mut dyn Write, values: &dyn Values, ) -> Result<(), Error>

Renders the template to the given writer io buffer with provided Values.
Source§

fn size_hint(&self) -> usize

Provides a conservative estimate of the expanded length of the rendered template.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.