Struct HtmlPage

Source

pub struct HtmlPage {
    pub meta: PageMetadata,
    pub private: bool,
    pub ttl: Option<TimeDelta>,
    pub render: Arc<dyn Send + Sync + for<'a> Fn(&'a HtmlPage, &'a RenderContext) -> Pin<Box<dyn Future<Output = Markup> + Send + Sync + 'a>> + 'static>,
    pub response_code: StatusCode,
    pub scripts: Vec<ScriptSource<String>>,
    pub styles: Vec<ScriptSource<String>>,
    pub extra_meta: Vec<(String, String)>,
}

Expand description

A complete, dynamically-rendered blob of HTML.

Fields§

§meta: PageMetadata

This page’s metadata

§private: bool

If true, the contents of this page never change

§ttl: Option<TimeDelta>

How long this page’s html may be cached. This controls the maximum age of a page shown to the user.

If None, this page is never cached.

§

render: Arc<dyn Send + Sync + for<'a> Fn(&'a HtmlPage, &'a RenderContext) -> Pin<Box<dyn Future<Output = Markup> + Send + Sync + 'a>> + 'static>

A function that generates this page’s html.

This should return the contents of this page’s

tag, or the contents of a wrapper element (defined in the page server struct).

This closure must never return <html> or <head>.

§response_code: StatusCode

The response code that should accompany this html

§scripts: Vec<ScriptSource<String>>

Scripts to include in this page. Order is preserved.

§styles: Vec<ScriptSource<String>>

Styles to include in this page. Order is preserved.

§extra_meta: Vec<(String, String)>

name, content for extra <meta> tags

Implementations§

Source §

impl HtmlPage

Source

pub fn with_meta(self, meta: PageMetadata) -> Self

Set self.meta

Source

pub fn with_render<R: Send + Sync + 'static + for<'a> Fn(&'a HtmlPage, &'a RenderContext) -> Pin<Box<dyn Future<Output = Markup> + Send + Sync + 'a>>>( self, render: R, ) -> Self

Set self.generate

Source

pub fn with_private(self, private: bool) -> Self

Set self.private

Source

pub fn with_ttl(self, ttl: Option<TimeDelta>) -> Self

Set self.html_ttl

Source

pub fn with_code(self, response_code: StatusCode) -> Self

Set self.response_code

Source

pub fn with_script_inline(self, script: impl Into<String>) -> Self

Add an inline script to this page (after existing scripts)

Source

pub fn with_script_linked(self, url: impl Into<String>) -> Self

Add a linked script to this page (after existing scripts)

Source

pub fn with_script(self, script: ScriptSource<impl Into<String>>) -> Self

Add a script to this page (after existing scripts)

Source

pub fn with_style_inline(self, style: impl Into<String>) -> Self

Add an inline script to this page (after existing styles)

Source

pub fn with_style_linked(self, url: impl Into<String>) -> Self

Add a linked style to this page (after existing styles)

Source

pub fn with_style(self, style: ScriptSource<impl Into<String>>) -> Self

Add a style to this page (after existing scripts)

Source

pub fn with_extra_meta( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a <meta> to this page (after existing <meta>s)

Trait Implementations§

Source §

impl Clone for HtmlPage

Source §

fn clone(&self) -> HtmlPage

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Default for HtmlPage

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Source §

impl Servable for HtmlPage

Source §

fn head<'a>( &'a self, _ctx: &'a RenderContext, ) -> Pin<Box<dyn Future<Output = Rendered<()>> + Send + Sync + 'a>>

Return the same response as Servable::render, but with an empty body. Read more

Source §

fn render<'a>( &'a self, ctx: &'a RenderContext, ) -> Pin<Box<dyn Future<Output = Rendered<RenderedBody>> + Send + Sync + 'a>>

Render this page. Must return the same metadata as Servable::head. Consider using crate::Rendered::with_body and Servable::head to implement this fn. Read more