summaryrefslogblamecommitdiffstats
path: root/docs/en/cowboy/2.8/manual/cowboy_req.uri/index.html
blob: 35ad52d2cd890500dddfb0ac4a5fd83d1e1e3ab6 (plain) (tree)
1
2
3
4
5
6
7
8
9








                                                                                           


                                                                                                                      
                                                   





                                                                                                      
               
























                                                                                                                                                                                   

















                                                                                                                                                                             
                        
                                         
                                      
                                                                                         


                                            













                                                                                                                                                                                                                                                                                                                                                  
                                  

                          
     




                                                                                                                                                      
     
                                                                                     
     
                                                                                                                              
     
     
     
     
                                        
                                                                         
                                  
                                                                                
     
                                                                                       
     
                                                                                                       
     
     
                                

                                                                                                                                           
                                                               


                                            



                                                                                                                                                                                                                                               
                                                               


                                            



                                                                                                                                                                                                                                                                                                                                                        
                                                               


                                            



                                                                                                                                                                                                                                             
                                                               


                                            



                                                                                                                                                                                                                                                                                                                          
                                                               


                                            



                                                                                                                                                                                                                                                                                                                       
                                                               


                                            

                                                                                                                                                                                            
                                

                                                                                                                                                                                                                                                                                                                         











                           
           





                          
                                                                           

        
                                                                                    










                                 

                                                                       

                                                                       

                                                                       

                                                                     

                                                                     

                                                                     

                                                                     

     











                                                                                                                                                                   
                                                                                                                                                                                                                                  


 

















                                                                                                                                                                                                                           
                                                             










                                         
<!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:uri(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:uri(3)</span></h1>

<h2 id="_name">Name</h2>
<p>cowboy_req:uri - Reconstructed URI</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">uri</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>())       <font color="#990000">-&gt;</font> <b><font color="#000000">uri</font></b>(<font color="#009900">Req</font>, #{})
<b><font color="#000000">uri</font></b>(<font color="#009900">Req</font> <font color="#990000">::</font> <b><font color="#000000">cowboy_req:req</font></b>(), <font color="#009900">Opts</font>) <font color="#990000">-&gt;</font> <font color="#009900">URI</font> <font color="#990000">::</font> <b><font color="#000000">iodata</font></b>()

<font color="#009900">Opts</font> <font color="#990000">::</font> #{
    <font color="#0000FF">scheme</font>   <font color="#990000">=&gt;</font> <b><font color="#000000">iodata</font></b>()           | <font color="#000080">undefined</font>,
    <font color="#0000FF">host</font>     <font color="#990000">=&gt;</font> <b><font color="#000000">iodata</font></b>()           | <font color="#000080">undefined</font>,
    <font color="#0000FF">port</font>     <font color="#990000">=&gt;</font> <b><font color="#000000">inet:port_number</font></b>() | <font color="#000080">undefined</font>,
    <font color="#0000FF">path</font>     <font color="#990000">=&gt;</font> <b><font color="#000000">iodata</font></b>()           | <font color="#000080">undefined</font>,
    <font color="#0000FF">qs</font>       <font color="#990000">=&gt;</font> <b><font color="#000000">iodata</font></b>()           | <font color="#000080">undefined</font>,
    <font color="#0000FF">fragment</font> <font color="#990000">=&gt;</font> <b><font color="#000000">iodata</font></b>()           | <font color="#000080">undefined</font>
}</tt></pre>
</div></div>
<p>Reconstruct the effective request URI, optionally modifying components.</p>
<p>By default Cowboy will build a URI using the components found in the request. Options allow disabling or replacing individual components.</p>
<h2 id="_arguments">Arguments</h2>
<dl><dt>Req</dt>
<dd><p>The Req object.</p>
</dd>
<dt>Opts</dt>
<dd><p>Map for overriding individual components.</p>
<p>To replace a component, provide its new value as a binary string or an iolist. To disable a component, set its value to <code>undefined</code>.</p>
<p>As this function always returns a valid URI, there are some things to note:</p>
<ul><li>Disabling the host also disables the scheme and port.
</li>
<li>There is no fragment component by default as these are not sent with the request.
</li>
<li>The port number may not appear in the resulting URI if it is the default port for the given scheme (http: 80; https: 443).
</li>
</ul>
</dd>
</dl>
<h2 id="_return_value">Return value</h2>
<p>The reconstructed URI is returned as an iolist or a binary string.</p>
<h2 id="_changelog">Changelog</h2>
<ul><li><strong>2.0</strong>: Individual components can be replaced or disabled.
</li>
<li><strong>2.0</strong>: Only the URI is returned, it is no longer wrapped in a tuple.
</li>
<li><strong>2.0</strong>: Function introduced. Replaces <code>host_url/1</code> and <code>url/1</code>.
</li>
</ul>
<h2 id="_examples">Examples</h2>
<p>With an effective request URI <a href="http://example.org/path/to/res?edit=1">http://example.org/path/to/res?edit=1</a> we can have:</p>
<div class="listingblock"><div class="title">Protocol relative form</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><i><font color="#9A1900">%% //example.org/path/to/res?edit=1</font></i>
<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">scheme</font> <font color="#990000">=&gt;</font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Serialized origin for use in the origin header</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><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">http://example.org</font></u>
<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">path</font> <font color="#990000">=&gt;</font> <font color="#000080">undefined</font>, <font color="#0000FF">qs</font> <font color="#990000">=&gt;</font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">HTTP/1.1 origin form (path and query string only)</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><i><font color="#9A1900">%% /path/to/res?edit=1</font></i>
<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">host</font> <font color="#990000">=&gt;</font> <font color="#000080">undefined</font>})<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Add a fragment to the URI</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><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">http://example.org/path/to/res</font></u><i><font color="#9A1900">?edit=1#errors</font></i>
<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">fragment</font> <font color="#990000">=&gt;</font> <font color="#990000">&lt;&lt;</font><font color="#FF0000">"errors"</font><font color="#990000">&gt;&gt;</font>})<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Ensure the scheme is HTTPS</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><i><font color="#9A1900">%% </font></i><u><font color="#0000FF">https://example.org/path/to/res</font></u><i><font color="#9A1900">?edit=1</font></i>
<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</font>, #{<font color="#0000FF">scheme</font> <font color="#990000">=&gt;</font> <font color="#990000">&lt;&lt;</font><font color="#FF0000">"https"</font><font color="#990000">&gt;&gt;</font>})<font color="#990000">.</font></tt></pre>
</div></div>
<div class="listingblock"><div class="title">Convert the URI to a binary string</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><b><font color="#000000">iolist_to_binary</font></b>(<b><font color="#000000">cowboy_req:uri</font></b>(<font color="#009900">Req</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.scheme">cowboy_req:scheme(3)</a>, <a href="../cowboy_req.host">cowboy_req:host(3)</a>, <a href="../cowboy_req.port">cowboy_req:port(3)</a>, <a href="../cowboy_req.path">cowboy_req:path(3)</a>, <a href="../cowboy_req.qs">cowboy_req:qs(3)</a></p>






</div>

<div class="span3 sidecol">


<h3>
	Cowboy
	2.8
	Function Reference
	
</h3>

<ul>
	
		<li><a href="/docs/en/cowboy/2.8/guide">User Guide</a></li>
	
	
		<li><a href="/docs/en/cowboy/2.8/manual">Function Reference</a></li>
	
	
</ul>

<h4 id="docs-nav">Navigation</h4>

<h4>Version select</h4>
<ul>
	
	
	
		<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 &copy; Loïc Hoguin 2012-2018</p>
            </div>
          </div>
        </div>
      </footer>

    
    <script src="/js/custom.js"></script>
  </body>
</html>