Struct perseus::template::Template

pub struct Template<G: GenericNode> { /* fields omitted */ }

This allows the specification of all the template templates in an app and how to render them. If no rendering logic is provided at all, the template will be prerendered at build-time with no state. All closures are stored on the heap to avoid hellish lifetime specification. All properties for templates are passed around as strings to avoid type maps and other horrible things, this only adds one extra deserialization call at build time.

Implementations

impl<G: GenericNode> Template<G>

pub fn new(path: impl Into<String> + Display) -> Self

Creates a new template definition.

pub fn render_for_template(&self, props: Option<String>) -> SycamoreTemplate<G>

Executes the user-given function that renders the template on the server-side (build or request time).

pub async fn get_build_paths(&self) -> Result<Vec<String>>

Gets the list of templates that should be prerendered for at build-time.

pub async fn get_build_state(&self, path: String) -> Result<String>

Gets the initial state for a template. This needs to be passed the full path of the template, which may be one of those generated by .get_build_paths().

pub async fn get_request_state(
    &self,
    path: String,
    req: Request
) -> Result<String>

Gets the request-time state for a template. This is equivalent to SSR, and will not be performed at build-time. Unlike .get_build_paths() though, this will be passed information about the request that triggered the render. Errors here can be caused by either the server or the client, so the user must specify an ErrorCause.

pub fn amalgamate_states(&self, states: States) -> Result<Option<String>>

Amalagmates given request and build states. Errors here can be caused by either the server or the client, so the user must specify an ErrorCause.

pub async fn should_revalidate(&self) -> Result<bool>

Checks, by the user’s custom logic, if this template should revalidate. This function isn’t presently parsed anything, but has network access etc., and can really do whatever it likes. Errors here can be caused by either the server or the client, so the user must specify an ErrorCause.

pub fn get_path(&self) -> String

Gets the path of the template. This is the root path under which any generated pages will be served. In the simplest case, there will only be one page rendered, and it will occupy that root position.

pub fn get_revalidate_interval(&self) -> Option<String>

Gets the interval after which the template will next revalidate.

pub fn revalidates(&self) -> bool

Checks if this template can revalidate existing prerendered templates.

pub fn revalidates_with_time(&self) -> bool

Checks if this template can revalidate existing prerendered templates after a given time.

pub fn revalidates_with_logic(&self) -> bool

Checks if this template can revalidate existing prerendered templates based on some given logic.

pub fn uses_incremental(&self) -> bool

Checks if this template can render more templates beyond those paths it explicitly defines.

pub fn uses_build_paths(&self) -> bool

Checks if this template is a template to generate paths beneath it.

pub fn uses_request_state(&self) -> bool

Checks if this template needs to do anything on requests for it.

pub fn uses_build_state(&self) -> bool

Checks if this template needs to do anything at build time.

pub fn can_amalgamate_states(&self) -> bool

Checks if this template has custom logic to amalgamate build and reqquest states if both are generated.

pub fn is_basic(&self) -> bool

Checks if this template defines no rendering logic whatsoever. Such templates will be rendered using SSG.

pub fn template(self, val: TemplateFn<G>) -> Template<G>

Sets the template rendering function to use.

pub fn build_paths_fn(self, val: GetBuildPathsFn) -> Template<G>

Enables the build paths strategy with the given function.

pub fn incremental_path_rendering(self, val: bool) -> Template<G>

Enables the incremental generation strategy with the given function.

pub fn build_state_fn(self, val: GetBuildStateFn) -> Template<G>

Enables the build state strategy with the given function.

pub fn request_state_fn(self, val: GetRequestStateFn) -> Template<G>

Enables the request state strategy with the given function.

pub fn should_revalidate_fn(self, val: ShouldRevalidateFn) -> Template<G>

Enables the revalidation strategy (logic variant) with the given function.

pub fn revalidate_after(self, val: String) -> Template<G>

Enables the revalidation strategy (time variant). This takes a time string of a form like 1w for one week. More details are available in the book.

pub fn amalgamate_states_fn(self, val: AmalgamateStatesFn) -> Template<G>

Enables state amalgamation with the given function.

Trait Implementations

impl<G: Clone + GenericNode> Clone for Template<G>

fn clone(&self) -> Template<G>

Returns a copy of the value.

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

Performs copy-assignment from source.