| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Decodes an entity-encoded string."><meta name="keywords" content="rust, rustlang, rust-lang, decode_html"><title>decode_html in htmlescape - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../htmlescape/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../htmlescape/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><div class="sidebar-elems"><h2><a href="index.html">In htmlescape</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Function <a href="index.html">htmlescape</a>::<wbr><a class="fn" href="#">decode_html</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/htmlescape/decode.rs.html#174-183">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust fn"><code>pub fn decode_html(s: &str) -> Result<String, <a class="struct" href="struct.DecodeErr.html" title="struct htmlescape::DecodeErr">DecodeErr</a>></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decodes an entity-encoded string.</p> |
| <p>Decodes an entity encoded string, replacing HTML entities (<code>&amp;</code>, <code>&#20;</code> …) with the |
| the corresponding character. Case matters for named entities, ie. <code>&Amp;</code> is invalid. |
| Case does not matter for hex entities, so <code>&#x2E;</code> and <code>&#x2e;</code> are treated the same.</p> |
| <h2 id="arguments"><a href="#arguments">Arguments</a></h2> |
| <ul> |
| <li><code>s</code> - Entity-encoded string to decode.</li> |
| </ul> |
| <h2 id="failure"><a href="#failure">Failure</a></h2> |
| <p>The function will fail if input string contains invalid named entities (eg. <code>&nosuchentity;</code>), |
| invalid hex entities (eg. <code>&#xRT;</code>), invalid decimal entities (eg. <code>&#-1;), unclosed entities (</code>s == “&amp hej och hå”`) or otherwise malformed entities.</p> |
| <p>This function will never return errors with <code>kind</code> set to <code>IoError</code> or <code>EncodingError</code>.</p> |
| </div></details></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="htmlescape" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
