|
|
<!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: Constraints</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=1" 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>Constraints</span></h1>
<p>Constraints are validation and conversion functions applied to user input.</p>
<p>They are used in various places in Cowboy, including the router and the <code>cowboy_req</code> match functions.</p>
<h2 id="_syntax">Syntax</h2>
<p>Constraints are provided as a list of fields. For each field in the list, specific constraints can be applied, as well as a default value if the field is missing.</p>
<p>A field can take the form of an atom <code>field</code>, a tuple with constraints <code>{field, Constraints}</code> or a tuple with constraints and a default value <code>{field, Constraints, Default}</code>. The <code>field</code> form indicates the field is mandatory.</p>
<p>Note that when used with the router, only the second form makes sense, as it does not use the default and the field is always defined.</p>
<p>Constraints for each field are provided as an ordered list of atoms or funs to apply. Built-in constraints are provided as atoms, while custom constraints are provided as funs.</p>
<p>When multiple constraints are provided, they are applied in the order given. If the value has been modified by a constraint then the next one receives the new value.</p>
<p>For example, the following constraints will first validate and convert the field <code>my_value</code> to an integer, and then check that the integer is positive:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><font color="#009900">PositiveFun</font> <font color="#990000">=</font> <b><font color="#0000FF">fun</font></b>
(<font color="#990000">_</font>, <font color="#009900">V</font>) <b><font color="#0000FF">when</font></b> <font color="#009900">V</font> <font color="#990000">></font> <font color="#993399">0</font> <font color="#990000">-></font>
{<font color="#FF6600">ok</font>, <font color="#009900">V</font>};
(<font color="#990000">_</font>, <font color="#990000">_</font>) <font color="#990000">-></font>
{<font color="#FF6600">error</font>, <font color="#FF6600">not_positive</font>}
<b><font color="#0000FF">end</font></b>,
{<font color="#FF6600">my_value</font>, [<font color="#FF6600">int</font>, <font color="#009900">PositiveFun</font>]}<font color="#990000">.</font></tt></pre>
</div></div>
<p>We ignore the first fun argument in this snippet. We shouldn't. We will simply learn what it is later in this chapter.</p>
<p>When there's only one constraint, it can be provided directly without wrapping it into a list:</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt>{<font color="#FF6600">my_value</font>, <font color="#FF6600">int</font>}</tt></pre>
</div></div>
<h2 id="_built_in_constraints">Built-in constraints</h2>
<p>Built-in constraints are specified as an atom:</p>
<table rules="all" width="100%" frame="border"
cellspacing="0" cellpadding="4">
<thead><tr><th>Constraint</th>
<th>Description</th>
</tr></thead><tbody><tr><td>int</td>
<td>Converts binary value to integer.</td>
</tr>
<tr><td>nonempty</td>
<td>Ensures the binary value is non-empty.</td>
</tr>
</tbody></table>
<h2 id="_custom_constraints">Custom constraints</h2>
<p>Custom constraints are specified as a fun. This fun takes two arguments. The first argument indicates the operation to be performed, and the second is the value. What the value is and what must be returned depends on the operation.</p>
<p>Cowboy currently defines three operations. The operation used for validating and converting user input is the <code>forward</code> operation.</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">forward</font>, <font color="#009900">Value</font>) <font color="#990000">-></font>
<b><font color="#0000FF">try</font></b>
{<font color="#FF6600">ok</font>, <b><font color="#000000">binary_to_integer</font></b>(<font color="#009900">Value</font>)}
<b><font color="#0000FF">catch</font></b> <font color="#990000">_:_</font> <font color="#990000">-></font>
{<font color="#FF6600">error</font>, <font color="#FF6600">not_an_integer</font>}
<b><font color="#0000FF">end</font></b>;</tt></pre>
</div></div>
<p>The value must be returned even if it is not converted by the constraint.</p>
<p>The <code>reverse</code> operation does the opposite: it takes a converted value and changes it back to what the user input would have been.</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">reverse</font>, <font color="#009900">Value</font>) <font color="#990000">-></font>
<b><font color="#0000FF">try</font></b>
{<font color="#FF6600">ok</font>, <b><font color="#000000">integer_to_binary</font></b>(<font color="#009900">Value</font>)}
<b><font color="#0000FF">catch</font></b> <font color="#990000">_:_</font> <font color="#990000">-></font>
{<font color="#FF6600">error</font>, <font color="#FF6600">not_an_integer</font>}
<b><font color="#0000FF">end</font></b>;</tt></pre>
</div></div>
<p>Finally, the <code>format_error</code> operation takes an error returned by any other operation and returns a formatted human-readable error message.</p>
<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8
by Lorenzo Bettini
http://www.lorenzobettini.it
http://www.gnu.org/software/src-highlite -->
<pre><tt><b><font color="#000000">int</font></b>(<font color="#FF6600">format_error</font>, {<font color="#FF6600">not_an_integer</font>, <font color="#009900">Value</font>}) <font color="#990000">-></font>
<b><font color="#000000">io_lib:format</font></b>(<font color="#FF0000">"The value ~p is not an integer."</font>, [<font color="#009900">Value</font>])<font color="#990000">.</font></tt></pre>
</div></div>
<p>Notice that for this case you get both the error and the value that was given to the constraint that produced this error.</p>
<p>Cowboy will not catch exceptions coming from constraint functions. They should be written to not emit any exceptions.</p>
<nav style="margin:1em 0">
<a style="float:left" href="https://ninenines.eu/docs/en/cowboy/2.4/guide/routing/">
Routing
</a>
<a style="float:right" href="https://ninenines.eu/docs/en/cowboy/2.4/guide/handlers/">
Handlers
</a>
</nav>
</div>
<div class="span3 sidecol">
<h3>
Cowboy
2.4
User Guide
</h3>
<ul>
<li><a href="/docs/en/cowboy/2.4/guide">User Guide</a></li>
<li><a href="/docs/en/cowboy/2.4/manual">Function Reference</a></li>
</ul>
<h4 id="docs-nav">Navigation</h4>
<h4>Version select</h4>
<ul>
<li><a href="/docs/en/cowboy/2.4/guide">2.4</a></li>
<li><a href="/docs/en/cowboy/2.3/guide">2.3</a></li>
<li><a href="/docs/en/cowboy/2.2/guide">2.2</a></li>
<li><a href="/docs/en/cowboy/2.1/guide">2.1</a></li>
<li><a href="/docs/en/cowboy/2.0/guide">2.0</a></li>
<li><a href="/docs/en/cowboy/1.0/guide">1.0</a></li>
</ul>
</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>
|
