Deploying to gh-pages from @ upa-url/upa@ed47482 🚀

main/index.html

@@ -209,17 +209,17 @@ <h2><a class="anchor" id="examples"></a>
 <div class="line">    }</div>
 <div class="line">}</div>
 <div class="ttc" id="aclassupa_1_1url_html"><div class="ttname"><a href="classupa_1_1url.html">upa::url</a></div><div class="ttdoc">URL class.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l00062">url.h:62</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_a00c9e7935052de9bdd5f7dc57922255e"><div class="ttname"><a href="classupa_1_1url.html#a00c9e7935052de9bdd5f7dc57922255e">upa::url::hostname</a></div><div class="ttdeci">bool hostname(StrT &amp;&amp;str)</div><div class="ttdoc">The hostname setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01509">url.h:1509</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_a2d7a437fd9b379476d0d9397abfa637b"><div class="ttname"><a href="classupa_1_1url.html#a2d7a437fd9b379476d0d9397abfa637b">upa::url::search</a></div><div class="ttdeci">bool search(StrT &amp;&amp;str)</div><div class="ttdoc">The search setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01549">url.h:1549</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_a37366859f7402a3773d68861a84ab3ee"><div class="ttname"><a href="classupa_1_1url.html#a37366859f7402a3773d68861a84ab3ee">upa::url::href</a></div><div class="ttdeci">bool href(StrT &amp;&amp;str)</div><div class="ttdoc">The href setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01443">url.h:1443</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_a39ea63cc60276d528b5469a16a308942"><div class="ttname"><a href="classupa_1_1url.html#a39ea63cc60276d528b5469a16a308942">upa::url::hash</a></div><div class="ttdeci">bool hash(StrT &amp;&amp;str)</div><div class="ttdoc">The hash setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01576">url.h:1576</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_a8e805bd6733405d829e58e8b4359597f"><div class="ttname"><a href="classupa_1_1url.html#a8e805bd6733405d829e58e8b4359597f">upa::url::password</a></div><div class="ttdeci">bool password(StrT &amp;&amp;str)</div><div class="ttdoc">The password setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01482">url.h:1482</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_aa183eb21c14a7d4f1880b6153aeb11b6"><div class="ttname"><a href="classupa_1_1url.html#aa183eb21c14a7d4f1880b6153aeb11b6">upa::url::username</a></div><div class="ttdeci">bool username(StrT &amp;&amp;str)</div><div class="ttdoc">The username setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01466">url.h:1466</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a00c9e7935052de9bdd5f7dc57922255e"><div class="ttname"><a href="classupa_1_1url.html#a00c9e7935052de9bdd5f7dc57922255e">upa::url::hostname</a></div><div class="ttdeci">bool hostname(StrT &amp;&amp;str)</div><div class="ttdoc">The hostname setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01504">url.h:1504</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a2d7a437fd9b379476d0d9397abfa637b"><div class="ttname"><a href="classupa_1_1url.html#a2d7a437fd9b379476d0d9397abfa637b">upa::url::search</a></div><div class="ttdeci">bool search(StrT &amp;&amp;str)</div><div class="ttdoc">The search setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01544">url.h:1544</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a37366859f7402a3773d68861a84ab3ee"><div class="ttname"><a href="classupa_1_1url.html#a37366859f7402a3773d68861a84ab3ee">upa::url::href</a></div><div class="ttdeci">bool href(StrT &amp;&amp;str)</div><div class="ttdoc">The href setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01438">url.h:1438</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a39ea63cc60276d528b5469a16a308942"><div class="ttname"><a href="classupa_1_1url.html#a39ea63cc60276d528b5469a16a308942">upa::url::hash</a></div><div class="ttdeci">bool hash(StrT &amp;&amp;str)</div><div class="ttdoc">The hash setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01571">url.h:1571</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a8e805bd6733405d829e58e8b4359597f"><div class="ttname"><a href="classupa_1_1url.html#a8e805bd6733405d829e58e8b4359597f">upa::url::password</a></div><div class="ttdeci">bool password(StrT &amp;&amp;str)</div><div class="ttdoc">The password setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01477">url.h:1477</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_aa183eb21c14a7d4f1880b6153aeb11b6"><div class="ttname"><a href="classupa_1_1url.html#aa183eb21c14a7d4f1880b6153aeb11b6">upa::url::username</a></div><div class="ttdeci">bool username(StrT &amp;&amp;str)</div><div class="ttdoc">The username setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01461">url.h:1461</a></div></div>
 <div class="ttc" id="aclassupa_1_1url_html_ac453ab48b67747219bcfc95462f61c53"><div class="ttname"><a href="classupa_1_1url.html#ac453ab48b67747219bcfc95462f61c53">upa::url::parse</a></div><div class="ttdeci">validation_errc parse(T &amp;&amp;str_url, const url *base=nullptr)</div><div class="ttdoc">Parses given URL string against base URL.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l00177">url.h:177</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_ad17810412671e9775490e95df79be11a"><div class="ttname"><a href="classupa_1_1url.html#ad17810412671e9775490e95df79be11a">upa::url::port</a></div><div class="ttdeci">bool port(StrT &amp;&amp;str)</div><div class="ttdoc">The port setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01520">url.h:1520</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_ad82c26035a5289e0f141a156806ad24c"><div class="ttname"><a href="classupa_1_1url.html#ad82c26035a5289e0f141a156806ad24c">upa::url::pathname</a></div><div class="ttdeci">bool pathname(StrT &amp;&amp;str)</div><div class="ttdoc">The pathname setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01538">url.h:1538</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_aefff2a396c60bb736c6af7c94e67e834"><div class="ttname"><a href="classupa_1_1url.html#aefff2a396c60bb736c6af7c94e67e834">upa::url::protocol</a></div><div class="ttdeci">bool protocol(StrT &amp;&amp;str)</div><div class="ttdoc">The protocol setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01455">url.h:1455</a></div></div>
-<div class="ttc" id="aclassupa_1_1url_html_af194de754979c9075d77af7c99c4d44f"><div class="ttname"><a href="classupa_1_1url.html#af194de754979c9075d77af7c99c4d44f">upa::url::origin</a></div><div class="ttdeci">std::string origin() const</div><div class="ttdoc">The origin getter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01134">url.h:1134</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_ad17810412671e9775490e95df79be11a"><div class="ttname"><a href="classupa_1_1url.html#ad17810412671e9775490e95df79be11a">upa::url::port</a></div><div class="ttdeci">bool port(StrT &amp;&amp;str)</div><div class="ttdoc">The port setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01515">url.h:1515</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_ad82c26035a5289e0f141a156806ad24c"><div class="ttname"><a href="classupa_1_1url.html#ad82c26035a5289e0f141a156806ad24c">upa::url::pathname</a></div><div class="ttdeci">bool pathname(StrT &amp;&amp;str)</div><div class="ttdoc">The pathname setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01533">url.h:1533</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_aefff2a396c60bb736c6af7c94e67e834"><div class="ttname"><a href="classupa_1_1url.html#aefff2a396c60bb736c6af7c94e67e834">upa::url::protocol</a></div><div class="ttdeci">bool protocol(StrT &amp;&amp;str)</div><div class="ttdoc">The protocol setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01450">url.h:1450</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_af194de754979c9075d77af7c99c4d44f"><div class="ttname"><a href="classupa_1_1url.html#af194de754979c9075d77af7c99c4d44f">upa::url::origin</a></div><div class="ttdeci">std::string origin() const</div><div class="ttdoc">The origin getter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01129">url.h:1129</a></div></div>
 <div class="ttc" id="anamespaceupa_html_a05a9cf5ac0b5dafa3ed684f3a17f4710"><div class="ttname"><a href="namespaceupa.html#a05a9cf5ac0b5dafa3ed684f3a17f4710">upa::success</a></div><div class="ttdeci">constexpr bool success(validation_errc res) noexcept</div><div class="ttdoc">Check validation error code indicates success.</div><div class="ttdef"><b>Definition</b> <a href="url__result_8h_source.html#l00092">url_result.h:92</a></div></div>
 </div><!-- fragment --><p>Parse URL against base URL using <code>url</code> constructor: </p><div class="fragment"><div class="line"><span class="keywordflow">try</span> {</div>
 <div class="line">    <a class="code hl_class" href="classupa_1_1url.html">upa::url</a> url{ <span class="stringliteral">&quot;/new path?query&quot;</span>, <span class="stringliteral">&quot;https://example.org/path&quot;</span> };</div>
@@ -237,12 +237,12 @@ <h2><a class="anchor" id="examples"></a>
 <div class="line">    url.<a class="code hl_function" href="classupa_1_1url.html#a39ea63cc60276d528b5469a16a308942">hash</a>(<span class="stringliteral">&quot;top&quot;</span>);</div>
 <div class="line">    std::cout &lt;&lt; url.<a class="code hl_function" href="classupa_1_1url.html#a37366859f7402a3773d68861a84ab3ee">href</a>() &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
 <div class="line">}</div>
-<div class="ttc" id="aclassupa_1_1url_html_a9596575079d483f7fd33527f61cc2a6b"><div class="ttname"><a href="classupa_1_1url.html#a9596575079d483f7fd33527f61cc2a6b">upa::url::host</a></div><div class="ttdeci">bool host(StrT &amp;&amp;str)</div><div class="ttdoc">The host setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01498">url.h:1498</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a9596575079d483f7fd33527f61cc2a6b"><div class="ttname"><a href="classupa_1_1url.html#a9596575079d483f7fd33527f61cc2a6b">upa::url::host</a></div><div class="ttdeci">bool host(StrT &amp;&amp;str)</div><div class="ttdoc">The host setter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01493">url.h:1493</a></div></div>
 </div><!-- fragment --><p>Enumerate search parameters of URL: </p><div class="fragment"><div class="line"><a class="code hl_class" href="classupa_1_1url.html">upa::url</a> url{ <span class="stringliteral">&quot;wss://h?first=last&amp;op=hop&amp;a=b&quot;</span> };</div>
 <div class="line"><span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span>&amp; param : url.<a class="code hl_function" href="classupa_1_1url.html#a4fb9b3f5a6ff3d88c213326423c17147">search_params</a>()) {</div>
 <div class="line">    std::cout &lt;&lt; param.first &lt;&lt; <span class="stringliteral">&quot; = &quot;</span> &lt;&lt; param.second &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
 <div class="line">}</div>
-<div class="ttc" id="aclassupa_1_1url_html_a4fb9b3f5a6ff3d88c213326423c17147"><div class="ttname"><a href="classupa_1_1url.html#a4fb9b3f5a6ff3d88c213326423c17147">upa::url::search_params</a></div><div class="ttdeci">url_search_params &amp; search_params() &amp;</div><div class="ttdoc">The searchParams getter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01233">url.h:1233</a></div></div>
+<div class="ttc" id="aclassupa_1_1url_html_a4fb9b3f5a6ff3d88c213326423c17147"><div class="ttname"><a href="classupa_1_1url.html#a4fb9b3f5a6ff3d88c213326423c17147">upa::url::search_params</a></div><div class="ttdeci">url_search_params &amp; search_params() &amp;</div><div class="ttdoc">The searchParams getter.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l01228">url.h:1228</a></div></div>
 </div><!-- fragment --><p>Remove search parameters whose names start with "utm_" (requires C++20): </p><div class="fragment"><div class="line"><a class="code hl_class" href="classupa_1_1url.html">upa::url</a> url{ <span class="stringliteral">&quot;https://example.com/?id=1&amp;utm_source=twitter.com&amp;utm_medium=social&quot;</span> };</div>
 <div class="line">url.<a class="code hl_function" href="classupa_1_1url.html#a4fb9b3f5a6ff3d88c213326423c17147">search_params</a>().<a class="code hl_function" href="classupa_1_1url__search__params.html#ac68e1da1c80834f3d30eb2e8e892f7e8">remove_if</a>([](<span class="keyword">const</span> <span class="keyword">auto</span>&amp; param) {</div>
 <div class="line">    <span class="keywordflow">return</span> param.first.starts_with(<span class="stringliteral">&quot;utm_&quot;</span>);</div>
@@ -257,7 +257,7 @@ <h2><a class="anchor" id="examples"></a>
 <div class="line">    std::cerr &lt;&lt; <span class="stringliteral">&quot;Error: &quot;</span> &lt;&lt; ex.what() &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
 <div class="line">}</div>
 <div class="ttc" id="anamespaceupa_html_a5806bc3a0d267938f093d8106d84360fa950616e5405e4ef51a87d384180e7aa1"><div class="ttname"><a href="namespaceupa.html#a5806bc3a0d267938f093d8106d84360fa950616e5405e4ef51a87d384180e7aa1">upa::file_path_format::posix</a></div><div class="ttdeci">@ posix</div><div class="ttdoc">POSIX file path format.</div></div>
-<div class="ttc" id="anamespaceupa_html_adbb039c01de48ad13cb733c8c32c588f"><div class="ttname"><a href="namespaceupa.html#adbb039c01de48ad13cb733c8c32c588f">upa::url_from_file_path</a></div><div class="ttdeci">url url_from_file_path(StrT &amp;&amp;str, file_path_format format=file_path_format::native)</div><div class="ttdoc">Make URL from OS file path.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l03173">url.h:3173</a></div></div>
+<div class="ttc" id="anamespaceupa_html_adbb039c01de48ad13cb733c8c32c588f"><div class="ttname"><a href="namespaceupa.html#adbb039c01de48ad13cb733c8c32c588f">upa::url_from_file_path</a></div><div class="ttdeci">url url_from_file_path(StrT &amp;&amp;str, file_path_format format=file_path_format::native)</div><div class="ttdoc">Make URL from OS file path.</div><div class="ttdef"><b>Definition</b> <a href="url_8h_source.html#l03118">url.h:3118</a></div></div>
 </div><!-- fragment --><h1><a class="anchor" id="license"></a>
 License</h1>
 <p>This library is licensed under the <a href="https://opensource.org/license/bsd-2-clause/">BSD 2-Clause License</a>. It contains portions of modified source code from the Chromium project, licensed under the <a href="https://opensource.org/license/bsd-3-clause/">BSD 3-Clause License</a>, and the ICU project, licensed under the <a href="https://www.unicode.org/license.txt">UNICODE LICENSE V3</a>.</p>

main/namespaceupa.html

@@ -304,7 +304,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5806bc3a0d267938f093d810
 </td></tr>
 </table>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03138">3138</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03083">3083</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>
@@ -550,7 +550,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a704170fa90d71a1899e48494
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03118">3118</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03063">3063</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>
@@ -583,7 +583,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adc0dcd205079a2dac68f58ce
 
 <p>Lexicographically compares two URL's. </p>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03123">3123</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03068">3068</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>
@@ -625,7 +625,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a01668f1801e81e167aa89011
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>OS path </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03254">3254</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03199">3199</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>
@@ -781,7 +781,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa223cc0cd1376e828988ca9b
   </dd>
 </dl>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03133">3133</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03078">3078</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>
@@ -870,7 +870,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adbb039c01de48ad13cb733c8
 <dl class="section return"><dt>Returns</dt><dd>file URL </dd></dl>
 <dl class="section see"><dt>See also</dt><dd><a href="https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_254">Pathname (POSIX)</a>, <a href="https://pubs.opengroup.org/onlinepubs/9799919799/functions/realpath.html">realpath</a>, <a href="https://learn.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getfullpathnamew">GetFullPathName</a>, <a href="https://en.cppreference.com/w/cpp/filesystem/canonical">std::filesystem::canonical</a> </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03173">3173</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03118">3118</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>

main/structstd_1_1hash_3_01upa_1_1url_01_4.html

@@ -130,7 +130,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>std::hash specialization for <a class="el" href="classupa_1_1url.html" title="URL class.">upa::url</a> class </p>
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03336">3336</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03281">3281</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="a17ef204bd073cdeffc4c2b4d5e91c8cc" name="a17ef204bd073cdeffc4c2b4d5e91c8cc"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a17ef204bd073cdeffc4c2b4d5e91c8cc">&#9670;&#160;</a></span>operator()()</h2>
@@ -155,7 +155,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a17ef204bd073cdeffc4c2b4d
 </table>
 </div><div class="memdoc">
 
-<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03337">3337</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
+<p class="definition">Definition at line <a class="el" href="url_8h_source.html#l03282">3282</a> of file <a class="el" href="url_8h_source.html">url.h</a>.</p>
 
 </div>
 </div>