<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/wezterm.url/Url.md - fork/wezterm @ termwiz-0.23.3</title>
<meta name="description" content="docs/config/lua/wezterm.url/Url.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:title" content="docs/config/lua/wezterm.url/Url.md - fork/wezterm @ termwiz-0.23.3">
<meta property="og:description" content="docs/config/lua/wezterm.url/Url.md in fork/wezterm at termwiz-0.23.3.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.3" data-tip="4bf28e253c0167102f07bfc7e7199c13eed98012">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="c85fa0b73b0e197ec95c1ed2cffa93dfbd5f8731">docs: update for latest release</span><span class="snapshot-sha sha" data-commit="c85fa0b73b0e197ec95c1ed2cffa93dfbd5f8731">c85fa0b73</span><time datetime="2024-01-27T12:50:49-07:00" title="2024-01-27 12:50:49 -0700">2024-01-27</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.3</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.3/tree/docs/config/lua/wezterm.url/">wezterm.url</a> / <span class="cur">Url.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>32 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/7a43026b26feb3ee3740222c867f6aac2cf8820d/docs/config/lua/wezterm.url/Url.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Url object</h1>
<p>{{since('20240127-113634-bbcac864')}}</p>
<p>The <code>Url</code> object represents a parsed Url.  It has the following fields:</p>
<ul>
<li><code>scheme</code> - the URL scheme such as <code>"file"</code>, or <code>"https"</code></li>
<li><code>file_path</code> - decodes the <code>path</code> field and interprets it as a file path</li>
<li><code>username</code> - the username portion of the URL, or an empty string if none is specified</li>
<li><code>password</code> - the password portion of the URL, or <code>nil</code> if none is specified</li>
<li><code>host</code> - the hostname portion of the URL, with IDNA decoded to UTF-8</li>
<li><code>path</code> - the path portion of the URL, complete with percent encoding</li>
<li><code>fragment</code> - the fragment portion of the URL</li>
<li><code>query</code> - the query portion of the URL</li>
</ul>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-k>local</a-k> <a-v>url</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>url</a-v><a-p>.</a-p><a-f>parse</a-f> <a-s>&#39;file://myhost/some/path%20with%20spaces&#39;</a-s>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>scheme</a-v> <a-o>==</a-o> <a-s>&#39;file&#39;</a-s><a-p>)</a-p>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>file_path</a-v> <a-o>==</a-o> <a-s>&#39;/some/path with spaces&#39;</a-s><a-p>)</a-p>

<a-k>local</a-k> <a-v>url</a-v> =
  <a-v>wezterm</a-v><a-p>.</a-p><a-v>url</a-v><a-p>.</a-p><a-f>parse</a-f> <a-s>&#39;https://github.com/rust-lang/rust/issues?labels=E-easy&amp;state=open&#39;</a-s>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>scheme</a-v> <a-o>==</a-o> <a-s>&#39;https&#39;</a-s><a-p>)</a-p>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>username</a-v> <a-o>==</a-o> <a-s>&#39;&#39;</a-s><a-p>)</a-p>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>password</a-v> <a-o>==</a-o> <a-co>nil</a-co><a-p>)</a-p>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>host</a-v> <a-o>==</a-o> <a-s>&#39;github.com&#39;</a-s><a-p>)</a-p>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>path</a-v> <a-o>==</a-o> <a-s>&#39;/rust-lang/rust/issues&#39;</a-s><a-p>)</a-p>
<a-f>assert</a-f><a-p>(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>query</a-v> <a-o>==</a-o> <a-s>&#39;labels=E-easy&amp;state=open&#39;</a-s><a-p>)</a-p></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Url object</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20240127-113634-bbcac864&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">The `Url` object represents a parsed Url.  It has the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>* </a-p>`scheme` - the URL scheme such as `&quot;file&quot;`, or `&quot;https&quot;`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>* </a-p>`file_path` - decodes the `path` field and interprets it as a file path</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>* </a-p>`username` - the username portion of the URL, or an empty string if none is specified</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>* </a-p>`password` - the password portion of the URL, or `nil` if none is specified</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>* </a-p>`host` - the hostname portion of the URL, with IDNA decoded to UTF-8</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>`path` - the path portion of the URL, complete with percent encoding</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>* </a-p>`fragment` - the fragment portion of the URL</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>* </a-p>`query` - the query portion of the URL</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>local </a-p><a-v>url</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>url</a-v><a-p>.</a-p><a-f>parse</a-f><a-p> </a-p><a-s>&#39;file://myhost/some/path%20with%20spaces&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>scheme</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;file&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>file_path</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;/some/path with spaces&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>local </a-p><a-v>url</a-v><a-p> =</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>  </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>url</a-v><a-p>.</a-p><a-f>parse</a-f><a-p> </a-p><a-s>&#39;https://github.com/rust-lang/rust/issues?labels=E-easy&amp;state=open&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>scheme</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;https&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>username</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>password</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-co>nil</a-co><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>host</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;github.com&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>path</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;/rust-lang/rust/issues&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>assert(</a-p><a-v>url</a-v><a-p>.</a-p><a-v>query</a-v><a-p> </a-p><a-o>==</a-o><a-p> </a-p><a-s>&#39;labels=E-easy&amp;state=open&#39;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
