Trait Render

pub trait Render {
    // Required method
    fn render_to(&self, f: &mut Formatter<'_>) -> Result;

    // Provided method
    fn render(&self) -> Raw<String> { ... }
}

Trait for safely rendering HTML content.

Render is similar to Display and Debug but it is for safely generating HTML.

Example

use std::fmt::{Formatter, Result};
use gen_html::Render;

struct Vector2D {
    x: f32,
    y: f32,
}

impl Render for Vector2D {
    fn render_to(&self, f: &mut Formatter) -> Result {
        let Self { x, y } = self;
        // `f32` cannot contain special characters, so we don't need to worry about escaping
        write!(f, "({x}, {y})")
    }
}

Required Methods

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

Renders HTML to a given formatter.

When implementing this function, you should make sure that the output is valid HTML.

Errors

This function should return Err if, and only if, the provided Formatter returns Err.

Provided Methods

fn render(&self) -> Raw<String>

Converts the given value to a Raw<String>.

let content = "<this is escaped>";
assert_eq!(content.render().0, "&lt;this is escaped&gt;");

Implementations on Foreign Types

impl Render for f32

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

impl Render for f64

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

impl Render for i8

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

impl Render for i16

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

impl Render for i32

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

impl Render for i64

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

impl Render for i128

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

impl Render for isize

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

impl Render for str

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

impl Render for u8

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

impl Render for u16

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

impl Render for u32

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

impl Render for u64

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

impl Render for u128

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

impl Render for usize

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

impl Render for String

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

impl Render for Arguments<'_>

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

impl<B> Render for Cow<'_, B>

where B: Render + ToOwned + ?Sized,

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

impl<T> Render for &T

where T: Render + ?Sized,

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

impl<T> Render for &mut T

where T: Render + ?Sized,

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

impl<T> Render for Box<T>

where T: Render + ?Sized,

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

impl<T> Render for Rc<T>

where T: Render + ?Sized,

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

impl<T> Render for Arc<T>

where T: Render + ?Sized,

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

Implementors

impl<F> Render for RenderFn<F>

where F: Fn(&mut Formatter<'_>) -> Result,

impl<T: Display> Render for Escaped<T>

impl<T: Display> Render for Raw<T>