plait 0.8.1

A modern HTML templating library for Rust that embraces composition.
Documentation 
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use std::{borrow::Cow, fmt, ops::Deref};

use crate::{RenderEscaped, RenderRaw};

/// An owned string of rendered HTML.
///
/// `Html` is a thin wrapper around [`String`] that represents already-rendered HTML content. It implements
/// [`Deref<Target = str>`](Deref), [`Display`](fmt::Display), and can be converted back into a [`String`] with
/// [`From`].
///
/// You typically obtain an `Html` value by calling [`ToHtml::to_html()`] on an [`HtmlFragment`](crate::HtmlFragment)
/// returned by the [`html!`](crate::html) macro.
///
/// Because the content is already rendered HTML, both [`RenderEscaped`] and [`RenderRaw`] write the inner string as-is
/// (no double-escaping).
///
/// # Example
///
/// ```
/// use plait::{html, ToHtml};
///
/// let fragment = html! { p { "Hello" } };
/// let html = fragment.to_html();
///
/// assert_eq!(html, "<p>Hello</p>");
/// assert_eq!(html.to_string(), "<p>Hello</p>");
/// ```
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Html(String);

impl Html {
    #[doc(hidden)]
    pub fn new_unchecked(s: String) -> Self {
        Html(s)
    }
}

impl Deref for Html {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl From<Html> for String {
    fn from(html: Html) -> Self {
        html.0
    }
}

impl fmt::Display for Html {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.0.fmt(f)
    }
}

impl PartialEq<&str> for Html {
    fn eq(&self, other: &&str) -> bool {
        self.0 == *other
    }
}

impl PartialEq<Cow<'_, str>> for Html {
    fn eq(&self, other: &Cow<'_, str>) -> bool {
        self.0 == *other
    }
}

impl RenderEscaped for Html {
    #[inline]
    fn render_escaped(&self, f: &mut (dyn fmt::Write + '_)) -> fmt::Result {
        f.write_str(&self.0)
    }
}

impl RenderRaw for Html {
    #[inline]
    fn render_raw(&self, f: &mut (dyn fmt::Write + '_)) -> fmt::Result {
        f.write_str(&self.0)
    }
}

#[cfg(feature = "actix-web")]
mod actix_web {
    use ::actix_web::{HttpRequest, HttpResponse, Responder};

    use super::*;

    #[cfg_attr(docsrs, doc(cfg(feature = "actix-web")))]
    impl Responder for Html {
        type Body = String;

        fn respond_to(self, req: &HttpRequest) -> HttpResponse<Self::Body> {
            ::actix_web::web::Html::new(self).respond_to(req)
        }
    }
}

#[cfg(feature = "axum")]
mod axum {
    use ::axum::response::{IntoResponse, Response};

    use super::*;

    #[cfg_attr(docsrs, doc(cfg(feature = "axum")))]
    impl IntoResponse for Html {
        fn into_response(self) -> Response {
            ::axum::response::Html(String::from(self)).into_response()
        }
    }
}

#[cfg(feature = "rocket")]
mod rocket {
    use ::rocket::{
        Request,
        response::{Responder, Result, content::RawHtml},
    };

    use super::*;

    #[cfg_attr(docsrs, doc(cfg(feature = "rocket")))]
    impl<'r, 'o: 'r> Responder<'r, 'o> for Html {
        fn respond_to(self, request: &'r Request<'_>) -> Result<'o> {
            RawHtml(String::from(self)).respond_to(request)
        }
    }
}

/// Trait for types that can be rendered into an [`Html`] value.
///
/// This is the primary way to materialize a template into an owned HTML string. The [`html!`](crate::html) macro
/// returns an [`HtmlFragment`](crate::HtmlFragment) that implements this trait.
///
/// # Example
///
/// ```
/// use plait::{html, ToHtml};
///
/// let fragment = html! { div { "Hello" } };
/// let html = fragment.to_html(); // Html value
/// println!("{html}");            // prints: <div>Hello</div>
/// ```
pub trait ToHtml {
    /// Renders `self` into an [`Html`] value.
    fn to_html(&self) -> Html;
}