Trait Renderable

Source

pub trait Renderable<C: Context = Node> {
    // Required method
    fn render_to(&self, buffer: &mut Buffer<C>);

    // Provided method
    fn render(&self) -> Rendered<String>
       where Self: Renderable { ... }
}

Available on crate feature alloc only.

Expand description

A type that can be rendered as an HTML node.

For Renderable<Node> (a.k.a. Renderable) implementations, this must render complete HTML nodes. If rendering string-like types, the implementation must escape & to &, < to <, and > to >.

For Renderable<AttributeValue> implementations, this must render an attribute value which will eventually be surrounded by double quotes. The implementation must escape & to &, < to <, > to >, and " to ".

§Example

use hypertext::{Buffer, prelude::*};

pub struct Person {
    name: String,
    age: u8,
}

impl Renderable for Person {
    fn render_to(&self, buffer: &mut Buffer) {
        maud! {
            div {
                h1 { (self.name) }
                p { "Age: " (self.age) }
            }
        }
        .render_to(buffer);
    }
}

let person = Person {
    name: "Alice".into(),
    age: 20,
};

assert_eq!(
    maud! { main { (person) } }.render().as_inner(),
    r#"<main><div><h1>Alice</h1><p>Age: 20</p></div></main>"#,
);

Required Methods§

Source

fn render_to(&self, buffer: &mut Buffer<C>)

Renders this value to the buffer.

Provided Methods§

Source

fn render(&self) -> Rendered<String>
where Self: Renderable,

Renders this value to a string. This is a convenience method that calls render_to into a new Buffer and returns the result.

If overriden for performance reasons, this must match the implementation of render_to.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait RenderableCopy item path

§Example

Required Methods§

fn render_to(&self, buffer: &mut Buffer<C>)

Provided Methods§

fn render(&self) -> Rendered<String>where Self: Renderable,

Dyn Compatibility§

Implementations on Foreign Types§

impl Renderable for char

fn render_to(&self, buffer: &mut Buffer)

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

impl Renderable for str

fn render_to(&self, buffer: &mut Buffer)

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

impl Renderable for String

fn render_to(&self, buffer: &mut Buffer)

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

impl Renderable for Arguments<'_>

fn render_to(&self, buffer: &mut Buffer)

impl Renderable<AttributeValue> for char

fn render_to(&self, buffer: &mut AttributeBuffer)

impl Renderable<AttributeValue> for str

fn render_to(&self, buffer: &mut AttributeBuffer)

impl Renderable<AttributeValue> for String

fn render_to(&self, buffer: &mut AttributeBuffer)

impl Renderable<AttributeValue> for Arguments<'_>

fn render_to(&self, buffer: &mut AttributeBuffer)

impl<'a, B: 'a + Renderable + ToOwned + ?Sized> Renderable for Cow<'a, B>

fn render_to(&self, buffer: &mut Buffer)

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

impl<'a, B: 'a + Renderable<AttributeValue> + ToOwned + ?Sized> Renderable<AttributeValue> for Cow<'a, B>

fn render_to(&self, buffer: &mut AttributeBuffer)

impl<C: Context> Renderable<C> for bool

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for f32

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for f64

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for i8

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for i16

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for i32

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for i64

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for i128

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for isize

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for u8

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for u16

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for u32

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for u64

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for u128

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<C: Context> Renderable<C> for ()

fn render_to(&self, _: &mut Buffer<C>)

impl<C: Context> Renderable<C> for usize

fn render_to(&self, buffer: &mut Buffer<C>)

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

impl<T: Renderable + ?Sized> Renderable for &T

Trait Renderable

fn render(&self) -> Rendered<String>
where Self: Renderable,

impl<C: Context, T: Debug> Renderable<C> for Debugged<T>
where for<'a> Arguments<'a>: Renderable<C>,

impl<C: Context, T: Display> Renderable<C> for Displayed<T>
where for<'a> Arguments<'a>: Renderable<C>,