ascode/docs/reference/url/index.html

<!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><title>url - AsCode - Terraform Alternative Syntax</title><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=https://ascode.run/images/favicon.png><link rel=stylesheet href=/css/style.min.df49831c6872564dff31a5f0978a9571f2c8110b513d4b3b1fc8ead41dcdc9f0.css></head><body class="page page-default-single"><div id=main-menu-mobile class=main-menu-mobile><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><div class=wrapper><div class=header><div class=container><div class=logo><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div class=logo-mobile><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div id=main-menu class=main-menu><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><button id=toggle-main-menu-mobile class="hamburger hamburger--slider" type=button>
<span class=hamburger-box><span class=hamburger-inner></span></span></button></div></div><div class="main container pt-2 pt-md-6 pb-3 pb-md-6"><div class=row><div class="col-12 col-md-3 mb-3"><div class=sidebar><div class=docs-menu><h4><a href=/docs/reference/>API Reference</a></h4><ul><li><a href=/docs/reference/types/>built-in</a></li><li><a href=/docs/reference/docker/>docker</a></li><li><a href=/docs/reference/base64/>encoding/base64</a></li><li><a href=/docs/reference/csv/>encoding/csv</a></li><li><a href=/docs/reference/json/>encoding/json</a></li><li><a href=/docs/reference/yaml/>encoding/yaml</a></li><li><a href=/docs/reference/http/>http</a></li><li><a href=/docs/reference/math/>math</a></li><li><a href=/docs/reference/os/>os</a></li><li><a href=/docs/reference/filepath/>path/filepath</a></li><li><a href=/docs/reference/re/>re</a></li><li><a href=/docs/reference/time/>time</a></li><li><a class=active href=/docs/reference/url/>url</a></li></ul></div><div style=font-size:90%;margin-top:40px><a href=/docs/>« Documentation</a></div></div></div><div class="col-12 col-md-9"><h1 class=title>url</h1><div class=content><h2 id=index>Index</h2><div class=toc><nav id=TableOfContents><ul><li><a href=#overview>Overview</a></li><li><a href=#functions>Functions</a><ul><li><a href=#def-bparseb>def <b>parse</b></a></li><li><a href=#def-bpath_escapeb>def <b>path_escape</b></a></li><li><a href=#def-bpath_escapeb-1>def <b>path_escape</b></a></li><li><a href=#def-bpath_unescapeb>def <b>path_unescape</b></a></li><li><a href=#def-bpath_unescapeb-1>def <b>path_unescape</b></a></li></ul></li><li><a href=#types>Types</a><ul><li><a href=#type-burlb>type <b>URL</b></a></li></ul></li></ul></nav></div><h2 id=overview>Overview</h2><p>url parses URLs and implements query escaping.</p><h2 id=functions>Functions</h2><h3 id=def-bparseb>def <b>parse</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>parse</span><span class=p>(</span><span class=nx>rawurl</span><span class=p>)</span> <span class=nx>URL</span>
</code></pre></div><p>Parse parses rawurl into a URL structure.</p><h6 id=arguments>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>rawurl</code></td><td><code>string</code></td><td>rawurl may be relative (a path, without a host) or absolute(starting with a scheme). Trying to parse a hostname and pathwithout a scheme is invalid but may not necessarily return anerror, due to parsing ambiguities.</td></tr></tbody></table><h3 id=def-bpath_escapeb>def <b>path_escape</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>path_escape</span><span class=p>(</span><span class=nx>s</span><span class=p>)</span>
</code></pre></div><p>escapes the string so it can be safely placed inside a URL path
segment, replacing special characters (including /) with %XX
sequences as needed.</p><h6 id=arguments-1>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>s</code></td><td><code>string</code></td><td></td></tr></tbody></table><h3 id=def-bpath_escapeb-1>def <b>path_escape</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>path_escape</span><span class=p>(</span><span class=nx>s</span><span class=p>)</span>
</code></pre></div><p>escapes the string so it can be safely placed inside a URL query.</p><h6 id=arguments-2>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>s</code></td><td><code>string</code></td><td></td></tr></tbody></table><h3 id=def-bpath_unescapeb>def <b>path_unescape</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>path_unescape</span><span class=p>(</span><span class=nx>s</span><span class=p>)</span>
</code></pre></div><p>does the inverse transformation of path_escape, converting each
3-byte encoded substring of the form &ldquo;%AB&rdquo; into the hex-decoded byte
0xAB. It returns an error if any % is not followed by two hexadecimal
digits. path_unescape is identical to query_unescape except that it
does not unescape &lsquo;+&rsquo; to ' ' (space).</p><h6 id=arguments-3>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>s</code></td><td><code>string</code></td><td></td></tr></tbody></table><h3 id=def-bpath_unescapeb-1>def <b>path_unescape</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>path_unescape</span><span class=p>(</span><span class=nx>s</span><span class=p>)</span>
</code></pre></div><p>does the inverse transformation of query_escape, converting each
3-byte encoded substring of the form &ldquo;%AB&rdquo; into the hex-decoded byte
0xAB. It returns an error if any % is not followed by two hexadecimal
digits.</p><h6 id=arguments-4>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>s</code></td><td><code>string</code></td><td></td></tr></tbody></table><h2 id=types>Types</h2><h3 id=type-burlb>type <b>URL</b></h3><p>Represents a parsed URL (technically, a URI reference).</p><h6 id=properties>Properties</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>scheme</code></td><td><code>string</code></td><td></td></tr><tr><td><code>opaque</code></td><td><code>string</code></td><td>Encoded opaque data.</td></tr><tr><td><code>username</code></td><td><code>string</code></td><td>Username information.</td></tr><tr><td><code>password</code></td><td><code>string</code></td><td>Password information.</td></tr><tr><td><code>host</code></td><td><code>string</code></td><td>Host or host:port.</td></tr><tr><td><code>path</code></td><td><code>string</code></td><td>Path (relative paths may omit leading slash).</td></tr><tr><td><code>raw_query</code></td><td><code>string</code></td><td>Encoded query values, without &lsquo;?'.</td></tr><tr><td><code>fragment</code></td><td><code>string</code></td><td>Fragment for references, without &lsquo;#'.</td></tr></tbody></table></div></div></div></div></div></div><div class=sub-footer><div class=container><div class=row><div class=col-12><div class=sub-footer-inner><ul><li><a href=https://github.com/mcuadros/ascod>Documentation version v1.3.0</a></li><li>Template by <a href=https://www.zerostatic.io>Robert Austin</a></li></ul></div></div></div></div><script type=text/javascript src=/js/scripts.min.be6fe1294698d6acd837c5182149cd1a24daae9fa1903ce810c264539d254d62.js></script></body></html>