1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use axum::response::IntoResponse;
use serde::Serialize;

/// An abstraction over different templating engines
///
/// # Implementing custom engines
///
/// ```
/// # use axum_template::TemplateEngine;
/// # use serde::Serialize;
/// # use std::convert::Infallible;
///
/// #[derive(Debug)]
/// pub struct CustomEngine;
///
/// impl TemplateEngine for CustomEngine {
///     type Error = Infallible;   
///     fn render<S: Serialize>(&self, key: &str, data: S) -> Result<String, Self::Error> {
///         /* Render your template and return the result */
///         let result = "Hello world".into();
///         Ok(result)    
///     }
/// }
/// ```
///
/// > See the full working example [`custom_engine.rs`]
///
/// [`custom_engine.rs`]: https://github.com/Altair-Bueno/axum-template/blob/main/examples/custom_engine.rs
pub trait TemplateEngine {
    /// Error type returned if the engine is unable to process the data
    type Error: IntoResponse;

    /// Renders the template defined by the given key using the Serializable data
    fn render<S: Serialize>(&self, key: &str, data: S) -> Result<String, Self::Error>;
}