Plug.HTML (Plug v1.17.0)

View Source

Conveniences for generating HTML.

Summary

Functions

html_escape(data)

Escapes the given HTML to string.

html_escape_to_iodata(data)

Escapes the given HTML to iodata.

Functions

html_escape(data)

@spec html_escape(String.t()) :: String.t()

Escapes the given HTML to string.

iex> Plug.HTML.html_escape("foo")
"foo"

iex> Plug.HTML.html_escape("<foo>")
"&lt;foo&gt;"

iex> Plug.HTML.html_escape("quotes: \" & \'")
"quotes: &quot; &amp; &#39;"

html_escape_to_iodata(data)

@spec html_escape_to_iodata(String.t()) :: iodata()

Escapes the given HTML to iodata.

iex> Plug.HTML.html_escape_to_iodata("foo")
"foo"

iex> Plug.HTML.html_escape_to_iodata("<foo>")
[[[] | "&lt;"], "foo" | "&gt;"]

iex> Plug.HTML.html_escape_to_iodata("quotes: \" & \'")
[[[[], "quotes: " | "&quot;"], " " | "&amp;"], " " | "&#39;"]