diff options
author | Loïc Hoguin <[email protected]> | 2025-02-18 09:51:22 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2025-02-18 09:51:22 +0100 |
commit | 25e93c91878b7f8536764b06d2cb72020031acd1 (patch) | |
tree | b8da36ff9d9d2372c0f1f046262670326740bdfc /docs/en/cowboy/2.13/manual/cowboy_req.parse_qs/index.html | |
parent | 21e7107a9ee413f27de9cb5b92711763be55717b (diff) | |
download | ninenines.eu-25e93c91878b7f8536764b06d2cb72020031acd1.tar.gz ninenines.eu-25e93c91878b7f8536764b06d2cb72020031acd1.tar.bz2 ninenines.eu-25e93c91878b7f8536764b06d2cb72020031acd1.zip |
Cowboy 2.13.0
Diffstat (limited to 'docs/en/cowboy/2.13/manual/cowboy_req.parse_qs/index.html')
-rw-r--r-- | docs/en/cowboy/2.13/manual/cowboy_req.parse_qs/index.html | 210 |
1 files changed, 210 insertions, 0 deletions
diff --git a/docs/en/cowboy/2.13/manual/cowboy_req.parse_qs/index.html b/docs/en/cowboy/2.13/manual/cowboy_req.parse_qs/index.html new file mode 100644 index 00000000..cd81bbc0 --- /dev/null +++ b/docs/en/cowboy/2.13/manual/cowboy_req.parse_qs/index.html @@ -0,0 +1,210 @@ +<!DOCTYPE html> +<html lang="en"> + +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="description" content=""> + <meta name="author" content="Loïc Hoguin based on a design from (Soft10) Pol Cámara"> + + <title>Nine Nines: cowboy_req:parse_qs(3)</title> + + <link href='https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic' rel='stylesheet' type='text/css'> + <link href="/css/99s.css?r=7" rel="stylesheet"> + + <link rel="shortcut icon" href="/img/ico/favicon.ico"> + <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/img/ico/apple-touch-icon-114.png"> + <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/img/ico/apple-touch-icon-72.png"> + <link rel="apple-touch-icon-precomposed" href="/img/ico/apple-touch-icon-57.png"> + + </head> + + +<body class=""> + <header id="page-head"> + <div id="topbar" class="container"> + <div class="row"> + <div class="span2"> + <h1 id="logo"><a href="/" title="99s">99s</a></h1> + </div> + <div class="span10"> + + <div id="side-header"> + <nav> + <ul> + <li><a title="Hear my thoughts" href="/articles">Articles</a></li> + <li><a title="Watch my talks" href="/talks">Talks</a></li> + <li class="active"><a title="Read the docs" href="/docs">Documentation</a></li> + <li><a title="Request my services" href="/services">Consulting & Training</a></li> + </ul> + </nav> + <ul id="social"> + <li> + <a href="https://github.com/ninenines" title="Check my Github repositories"><img src="/img/ico_github.png" data-hover="/img/ico_github_alt.png" alt="Github"></a> + </li> + <li> + <a title="Contact me" href="mailto:[email protected]"><img src="/img/ico_mail.png" data-hover="/img/ico_mail_alt.png"></a> + </li> + </ul> + </div> + </div> + </div> + </div> + + +</header> + +<div id="contents" class="two_col"> +<div class="container"> +<div class="row"> +<div id="docs" class="span9 maincol"> + +<h1 class="lined-header"><span>cowboy_req:parse_qs(3)</span></h1> + +<h2 id="_name">Name</h2> +<p>cowboy_req:parse_qs - Parse the query string</p> +<h2 id="_description">Description</h2> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><b><font color="#000000">parse_qs</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>()) + <font color="#990000">-></font> [{<font color="#009900">Key</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>(), <font color="#009900">Value</font> <font color="#990000">::</font> <b><font color="#000080">binary</font></b>() | <font color="#000080">true</font>}]</tt></pre> +</div></div> +<p>Parse the query string as a list of key/value pairs.</p> +<h2 id="_arguments">Arguments</h2> +<dl><dt>Req</dt> +<dd><p>The Req object.</p> +</dd> +</dl> +<h2 id="_return_value">Return value</h2> +<p>The parsed query string is returned as a list of key/value pairs. The key is a binary string. The value is either a binary string, or the atom <code>true</code>. Both key and value are case sensitive.</p> +<p>The atom <code>true</code> is returned when a key is present in the query string without a value. For example, in the following URIs the key <code><<"edit">></code> will always have the value <code>true</code>:</p> +<ul><li><code>/posts/42?edit</code> +</li> +<li><code>/posts/42?edit&exclusive=1</code> +</li> +<li><code>/posts/42?exclusive=1&edit</code> +</li> +<li><code>/posts/42?exclusive=1&edit&from=web</code> +</li> +</ul> +<h2 id="_changelog">Changelog</h2> +<ul><li><strong>2.0</strong>: The parsed value is not longer cached in the Req object. +</li> +<li><strong>2.0</strong>: Only the parsed query string is returned, it is no longer wrapped in a tuple. +</li> +<li><strong>2.0</strong>: Function introduced. Replaces <code>qs_val/1</code> and <code>qs_vals/1</code>. +</li> +</ul> +<h2 id="_examples">Examples</h2> +<div class="listingblock"><div class="title">Parse the query string and convert the keys to atoms</div> +<div class="content"><!-- Generator: GNU source-highlight 3.1.9 +by Lorenzo Bettini +http://www.lorenzobettini.it +http://www.gnu.org/software/src-highlite --> +<pre><tt><font color="#009900">ParsedQs</font> <font color="#990000">=</font> <b><font color="#000000">cowboy_req:parse_qs</font></b>(<font color="#009900">Req</font>), +<font color="#009900">AtomsQs</font> <font color="#990000">=</font> [{<b><font color="#000000">binary_to_existing_atom</font></b>(<font color="#009900">K</font>, <font color="#FF6600">latin1</font>), <font color="#009900">V</font>} + || {<font color="#009900">K</font>, <font color="#009900">V</font>} <font color="#990000"><-</font> <font color="#009900">ParsedQs</font>]<font color="#990000">.</font></tt></pre> +</div></div> +<h2 id="_see_also">See also</h2> +<p><a href="../cowboy_req">cowboy_req(3)</a>, <a href="../cowboy_req.qs">cowboy_req:qs(3)</a>, <a href="../cowboy_req.match_qs">cowboy_req:match_qs(3)</a></p> + + + + + + +</div> + +<div class="span3 sidecol"> + + +<h3> + Cowboy + 2.13 + Function Reference + +</h3> + +<ul> + + <li><a href="/docs/en/cowboy/2.13/guide">User Guide</a></li> + + + <li><a href="/docs/en/cowboy/2.13/manual">Function Reference</a></li> + + +</ul> + +<h4 id="docs-nav">Navigation</h4> + +<h4>Version select</h4> +<ul> + + + + <li><a href="/docs/en/cowboy/2.13/manual">2.13</a></li> + + <li><a href="/docs/en/cowboy/2.12/manual">2.12</a></li> + + <li><a href="/docs/en/cowboy/2.11/manual">2.11</a></li> + + <li><a href="/docs/en/cowboy/2.10/manual">2.10</a></li> + + <li><a href="/docs/en/cowboy/2.9/manual">2.9</a></li> + + <li><a href="/docs/en/cowboy/2.8/manual">2.8</a></li> + + <li><a href="/docs/en/cowboy/2.7/manual">2.7</a></li> + + <li><a href="/docs/en/cowboy/2.6/manual">2.6</a></li> + +</ul> + +<h3 id="_like_my_work__donate">Like my work? Donate!</h3> +<p>Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:</p> +<form action="https://www.paypal.com/cgi-bin/webscr" method="post" style="display:inline"> +<input type="hidden" name="cmd" value="_donations"> +<input type="hidden" name="business" value="[email protected]"> +<input type="hidden" name="lc" value="FR"> +<input type="hidden" name="item_name" value="Loic Hoguin"> +<input type="hidden" name="item_number" value="99s"> +<input type="hidden" name="currency_code" value="EUR"> +<input type="hidden" name="bn" value="PP-DonationsBF:btn_donate_LG.gif:NonHosted"> +<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" border="0" name="submit" alt="PayPal - The safer, easier way to pay online!"> +<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1"> +</form><p>Recurring payment options are also available via <a href="https://github.com/sponsors/essen">GitHub Sponsors</a>. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.</p> + + + +</div> +</div> +</div> +</div> + + <footer> + <div class="container"> + <div class="row"> + <div class="span6"> + <p id="scroll-top"><a href="#">↑ Scroll to top</a></p> + <nav> + <ul> + <li><a href="mailto:[email protected]" title="Contact us">Contact us</a></li><li><a href="https://github.com/ninenines/ninenines.github.io" title="Github repository">Contribute to this site</a></li> + </ul> + </nav> + </div> + <div class="span6 credits"> + <p><img src="/img/footer_logo.png"></p> + <p>Copyright © Loïc Hoguin 2012-2018</p> + </div> + </div> + </div> + </footer> + + + <script src="/js/custom.js"></script> + </body> +</html> + + |