127 lines
3.8 KiB
Rust
127 lines
3.8 KiB
Rust
//! Sailfish is a simple, small, and extremely fast template engine for Rust.
|
|
//! Before reading this reference,
|
|
//! I recommend reading [User guide](https://rust-sailfish.github.io/sailfish/).
|
|
//!
|
|
//! This crate contains utilities for rendering sailfish template.
|
|
//! If you want to use sailfish templates, import `sailfish-macros` crate and use
|
|
//! derive macro `#[derive(TemplateOnce)]` or `#[derive(Template)]`.
|
|
//!
|
|
//! In most cases you don't need to care about the `runtime` module in this crate, but
|
|
//! if you want to render custom data inside templates, you must implement
|
|
//! `runtime::Render` trait for that type.
|
|
//!
|
|
//! ```ignore
|
|
//! use sailfish::TemplateOnce;
|
|
//!
|
|
//! #[derive(TemplateOnce)]
|
|
//! #[template(path = "hello.stpl")]
|
|
//! struct HelloTemplate {
|
|
//! messages: Vec<String>
|
|
//! }
|
|
//!
|
|
//! fn main() {
|
|
//! let ctx = HelloTemplate {
|
|
//! messages: vec!["foo".to_string(), "bar".to_string()]
|
|
//! };
|
|
//!
|
|
//! println!("{}", ctx.render_once().unwrap());
|
|
//! }
|
|
//! ```
|
|
|
|
#![doc(
|
|
html_logo_url = "https://raw.githubusercontent.com/rust-sailfish/sailfish/master/resources/icon.png"
|
|
)]
|
|
#![cfg_attr(sailfish_nightly, feature(core_intrinsics))]
|
|
#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
#![allow(clippy::redundant_closure)]
|
|
#![deny(missing_docs)]
|
|
#![feature(specialization)]
|
|
|
|
pub mod runtime;
|
|
|
|
use runtime::Buffer;
|
|
pub use runtime::{RenderError, RenderResult};
|
|
#[cfg(feature = "derive")]
|
|
#[cfg_attr(docsrs, doc(cfg(feature = "derive")))]
|
|
pub use sailfish_macros::TemplateOnce;
|
|
|
|
/// Template that can be rendered with consuming itself.
|
|
pub trait TemplateOnce: Sized {
|
|
/// Render the template and return the rendering result as `RenderResult`
|
|
///
|
|
/// This method never returns `Err`, unless you explicitly return RenderError
|
|
/// inside templates
|
|
///
|
|
/// When you use `render_once` method, total rendered size will be cached, and at
|
|
/// the next time, buffer will be pre-allocated based on the cached length.
|
|
///
|
|
/// If you don't want this behaviour, you can use `render_once_to` method instead.
|
|
fn render_once(self) -> runtime::RenderResult;
|
|
|
|
/// Render the template and append the result to `buf`.
|
|
///
|
|
/// This method never returns `Err`, unless you explicitly return RenderError
|
|
/// inside templates
|
|
///
|
|
/// ```
|
|
/// use sailfish::TemplateOnce;
|
|
/// use sailfish::runtime::Buffer;
|
|
///
|
|
/// # pub struct HelloTemplate {
|
|
/// # messages: Vec<String>,
|
|
/// # }
|
|
/// #
|
|
/// # impl TemplateOnce for HelloTemplate {
|
|
/// # fn render_once(self) -> Result<String, sailfish::RenderError> {
|
|
/// # Ok(String::new())
|
|
/// # }
|
|
/// #
|
|
/// # fn render_once_to(self, buf: &mut Buffer)
|
|
/// # -> Result<(), sailfish::RenderError> {
|
|
/// # Ok(())
|
|
/// # }
|
|
/// # }
|
|
/// #
|
|
/// # impl sailfish::private::Sealed for HelloTemplate {}
|
|
/// #
|
|
/// let tpl = HelloTemplate {
|
|
/// messages: vec!["foo".to_string()]
|
|
/// };
|
|
///
|
|
/// // custom pre-allocation
|
|
/// let mut buffer = Buffer::with_capacity(100);
|
|
/// tpl.render_once_to(&mut buffer).unwrap();
|
|
/// ```
|
|
fn render_once_to(self, buf: &mut Buffer) -> Result<(), RenderError>;
|
|
}
|
|
|
|
/// Work in Progress
|
|
pub trait Template
|
|
where
|
|
for<'a> &'a Self: TemplateOnce,
|
|
{
|
|
/// Work in progress
|
|
fn render(&self) -> runtime::RenderResult;
|
|
|
|
/// Work in progress
|
|
fn render_to(&self, buf: &mut Buffer) -> Result<(), RenderError>;
|
|
}
|
|
|
|
impl<T> Template for T
|
|
where
|
|
for<'a> &'a T: TemplateOnce,
|
|
{
|
|
fn render(&self) -> runtime::RenderResult {
|
|
TemplateOnce::render_once(self)
|
|
}
|
|
|
|
fn render_to(&self, buf: &mut Buffer) -> Result<(), RenderError> {
|
|
TemplateOnce::render_once_to(self, buf)
|
|
}
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub mod private {
|
|
pub trait Sealed {}
|
|
}
|