rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Rocket/contrib/dyn_templates
History
Sergio Benitez 7cc818cd85 Introduce dynamic TLS resolvers. 
This commit introduces the ability to dynamically select a TLS
configuration based on the client's TLS hello via the new `Resolver`
trait. In support of this, it also makes the following changes:

  * Added `Authority::set_port()`.
  * `UdsListener` is now `UnixListener`.
  * `Bindable` removed in favor of new `Bind`.
  * All built-in listeners now implement `Bind<&Rocket>`.
  * `Connection` requires `AsyncRead + AsyncWrite`.
  * The `Debug` impl for `Endpoint` displays the underlying address.
  * `Listener` must be `Sized`.
  * The TLS listener was moved to `tls::TlsListener`.
  * The preview `quic` listener no longer implements `Listener`.
  * Added `TlsConfig::server_config()`.
  * Added `race` future helpers.
  * Added `Rocket::launch_with()`, `Rocket::bind_launch()`.
  * Added a default `client.pem` to the TLS example.
  * Various unnecessary listener `Config` structures removed.

In addition, the testbench was revamped to support more scenarios. This
resulted in the following issues being found and fixed:

  * Fix an issue where the logger would ignore color requests.
  * Clarified docs for `mtls::Certificate` guard.
  * Improved error messages on listener misconfiguration.

Resolves #2730.
Resolves #2363.
Closes #2748.
Closes #2683.
Closes #2577.
 		2024-04-16 23:50:28 -07:00
..
src Introduce dynamic TLS resolvers. 2024-04-16 23:50:28 -07:00
tests Support minijinja in 'dyn_templates'. 2024-04-03 14:54:01 -07:00
Cargo.toml Support minijinja in 'dyn_templates'. 2024-04-03 14:54:01 -07:00
LICENSE-APACHE Symlink license files in all crate directories. 2024-04-06 20:46:07 -07:00
LICENSE-MIT Symlink license files in all crate directories. 2024-04-06 20:46:07 -07:00
README.md Update handlebars version in dyn_templates docs. 2024-01-17 21:41:25 -08:00

README.md

dyn_templates ci.svg crates.io docs.svg

This crate adds support for dynamic template rendering to Rocket. It automatically discovers templates, provides a Responder to render templates, and automatically reloads templates when compiled in debug mode. At present, it supports Handlebars and Tera.

Usage

  1. Enable the rocket_dyn_templates feature corresponding to your templating engine(s) of choice:

    [dependencies.rocket_dyn_templates]
version = "0.1.0"
features = ["handlebars", "tera"]

  2. Write your template files in Handlebars (.hbs) and/or Tera (.tera) in the configurable template_dir directory (default: {rocket_root}/templates).

  3. Attach Template::fairing() and return a Template using Template::render(), supplying the name of the template file minus the last two extensions:

    use rocket_dyn_templates::{Template, context};

#[get("/")]
fn index() -> Template {
    Template::render("template-name", context! { field: "value" })
}

#[launch]
fn rocket() -> _ {
    rocket::build().attach(Template::fairing())
}

See the crate docs for full details.