blob: 1d5dc4b3a959ab24f1eda522cd49f7c60abd2693 [file] [log] [blame]
<!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="Parser and serializer for the `application/x-www-form-urlencoded` syntax, as used by HTML forms."><meta name="keywords" content="rust, rustlang, rust-lang, form_urlencoded"><title>form_urlencoded - 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="../crates.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 mod crate"><!--[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">&#9776;</button><a class="sidebar-logo" href="../form_urlencoded/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="../form_urlencoded/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate form_urlencoded</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></section></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">Crate <a class="mod" href="#">form_urlencoded</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/form_urlencoded/lib.rs.html#9-416">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parser and serializer for the <a href="http://url.spec.whatwg.org/#application/x-www-form-urlencoded"><code>application/x-www-form-urlencoded</code> syntax</a>,
as used by HTML forms.</p>
<p>Converts between a string (such as an URL’s query string)
and a sequence of (name, value) pairs.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ByteSerialize.html" title="form_urlencoded::ByteSerialize struct">ByteSerialize</a></div><div class="item-right docblock-short">Return value of <code>byte_serialize()</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Parse.html" title="form_urlencoded::Parse struct">Parse</a></div><div class="item-right docblock-short">The return type of <code>parse()</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParseIntoOwned.html" title="form_urlencoded::ParseIntoOwned struct">ParseIntoOwned</a></div><div class="item-right docblock-short">Like <code>Parse</code>, but yields pairs of <code>String</code> instead of pairs of <code>Cow&lt;str&gt;</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Serializer.html" title="form_urlencoded::Serializer struct">Serializer</a></div><div class="item-right docblock-short">The <a href="https://url.spec.whatwg.org/#concept-urlencoded-serializer"><code>application/x-www-form-urlencoded</code> serializer</a>.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Target.html" title="form_urlencoded::Target trait">Target</a></div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.byte_serialize.html" title="form_urlencoded::byte_serialize fn">byte_serialize</a></div><div class="item-right docblock-short">The <a href="https://url.spec.whatwg.org/#concept-urlencoded-byte-serializer"><code>application/x-www-form-urlencoded</code> byte serializer</a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.parse.html" title="form_urlencoded::parse fn">parse</a></div><div class="item-right docblock-short">Convert a byte string in the <code>application/x-www-form-urlencoded</code> syntax
into a iterator of (name, value) pairs.</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.EncodingOverride.html" title="form_urlencoded::EncodingOverride type">EncodingOverride</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="form_urlencoded" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>