Struct trillium_handlebars::HandlebarsHandler
source · pub struct HandlebarsHandler(/* private fields */);
Expand description
A trillium handler that provides registered templates to downsequence handlers
Implementations§
source§impl HandlebarsHandler
impl HandlebarsHandler
sourcepub fn new(source: impl Into<Self>) -> Self
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§
source§impl Clone for HandlebarsHandler
impl Clone for HandlebarsHandler
source§fn clone(&self) -> HandlebarsHandler
fn clone(&self) -> HandlebarsHandler
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for HandlebarsHandler
impl Debug for HandlebarsHandler
source§impl Default for HandlebarsHandler
impl Default for HandlebarsHandler
source§fn default() -> HandlebarsHandler
fn default() -> HandlebarsHandler
Returns the “default value” for a type. Read more
source§impl From<&str> for HandlebarsHandler
impl From<&str> for HandlebarsHandler
source§impl From<Registry<'static>> for HandlebarsHandler
impl From<Registry<'static>> for HandlebarsHandler
source§fn from(ah: Handlebars<'static>) -> Self
fn from(ah: Handlebars<'static>) -> Self
Converts to this type from the input type.
source§impl From<PathBuf> for HandlebarsHandler
impl From<PathBuf> for HandlebarsHandler
source§impl Handler for HandlebarsHandler
impl Handler for HandlebarsHandler
source§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,
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.
source§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,
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. Read more
source§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,
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. Read more
source§fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool
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
in a subsequent call to Handler::upgrade
source§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,
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.Auto Trait Implementations§
impl Freeze for HandlebarsHandler
impl RefUnwindSafe for HandlebarsHandler
impl Send for HandlebarsHandler
impl Sync for HandlebarsHandler
impl Unpin for HandlebarsHandler
impl UnwindSafe for HandlebarsHandler
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)