Struct trillium_handlebars::HandlebarsHandler

pub struct HandlebarsHandler(/* private fields */);

A trillium handler that provides registered templates to downsequence handlers

Implementations

impl HandlebarsHandler

pub fn new(source: impl Into<Self>) -> Self

Builds a new trillium Handlebars handler from either a directory glob string or PathBuf or a handlebars::Handlebars<'static> instance

From a glob

use trillium_handlebars::{HandlebarsHandler, HandlebarsConnExt};
let handler = (
    HandlebarsHandler::new("**/*.hbs"),
    |mut conn: trillium::Conn| async move {
        conn.assign("name", "handlebars")
            .render("examples/templates/hello.hbs")
    }
);

use trillium_testing::prelude::*;
assert_ok!(get("/").on(&handler), "hello handlebars!");

From a handlebars::Handlebars

use trillium_handlebars::{HandlebarsHandler, Handlebars, HandlebarsConnExt};
// building a Handlebars directly
let mut handlebars = Handlebars::new();
handlebars.register_template_string("greet-user", "Hello {{name}}")?;
let handler = (
    HandlebarsHandler::new(handlebars),
    |mut conn: trillium::Conn| async move {
        conn.assign("name", "handlebars")
            .render("greet-user")
    }
);

use trillium_testing::prelude::*;
assert_ok!(get("/").on(&handler), "Hello handlebars");

Trait Implementations

impl Clone for HandlebarsHandler

fn clone(&self) -> HandlebarsHandler

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HandlebarsHandler

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

Formats the value using the given formatter.

impl Default for HandlebarsHandler

fn default() -> HandlebarsHandler

Returns the “default value” for a type.

impl From<&str> for HandlebarsHandler

fn from(pattern: &str) -> Self

Converts to this type from the input type.

impl From<Registry<'static>> for HandlebarsHandler

fn from(ah: Handlebars<'static>) -> Self

Converts to this type from the input type.

impl From<PathBuf> for HandlebarsHandler

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl Handler for HandlebarsHandler

fn run<'life0, 'async_trait>( &'life0 self, conn: Conn ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes this handler, performing any modifications to the Conn that are desired.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, _info: &'life1 mut Info ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send<'life0, 'async_trait>( &'life0 self, conn: Conn ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement [Handler::upgrade]. The first handler that responds true to this will receive ownership of the [trillium::Upgrade][crate::Upgrade] in a subsequent call to [Handler::upgrade]

fn upgrade<'life0, 'async_trait>( &'life0 self, _upgrade: Upgrade<BoxedTransport> ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

This will only be called if the handler reponds true to [Handler::has_upgrade] and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.