blob: fa7d2d4aaa4161079eed90d05f51cb6ad1b7537a [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg/catalog/rest/rest_util.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_a7beda0dac529a54d3cdf90e787bdce7.html">catalog</a></li><li class="navelem"><a class="el" href="dir_08d6efe6feae927f0fa1ad794a1878b0.html">rest</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">rest_util.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Provide utilities for REST catalog path and config handling.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;string_view&gt;</code><br />
<code>#include &lt;unordered_map&gt;</code><br />
<code>#include &lt;unordered_set&gt;</code><br />
<code>#include &quot;<a class="el" href="endpoint_8h_source.html">iceberg/catalog/rest/endpoint.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="iceberg__rest__export_8h_source.html">iceberg/catalog/rest/iceberg_rest_export.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="catalog_2rest_2type__fwd_8h_source.html">iceberg/catalog/rest/type_fwd.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="result_8h_source.html">iceberg/result.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="type__fwd_8h_source.html">iceberg/type_fwd.h</a>&quot;</code><br />
</div>
<p><a href="rest__util_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceiceberg" id="r_namespaceiceberg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
<tr class="memdesc:namespaceiceberg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceiceberg_1_1rest" id="r_namespaceiceberg_1_1rest"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html">iceberg::rest</a></td></tr>
<tr class="memdesc:namespaceiceberg_1_1rest"><td class="mdescLeft">&#160;</td><td class="mdescRight">REST catalog APIs. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adb65e3a4660c8f4208bafcf640871049" id="r_adb65e3a4660c8f4208bafcf640871049"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#adb65e3a4660c8f4208bafcf640871049">iceberg::rest::TrimTrailingSlash</a> (std::string_view str)</td></tr>
<tr class="memdesc:adb65e3a4660c8f4208bafcf640871049"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trim trailing slashes from a string. <br /></td></tr>
<tr class="separator:adb65e3a4660c8f4208bafcf640871049"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa2a021ff974a4f832114cb2ac78875" id="r_a4aa2a021ff974a4f832114cb2ac78875"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#a4aa2a021ff974a4f832114cb2ac78875">iceberg::rest::EncodeString</a> (std::string_view str_to_encode)</td></tr>
<tr class="memdesc:a4aa2a021ff974a4f832114cb2ac78875"><td class="mdescLeft">&#160;</td><td class="mdescRight">URL-encode a string (RFC 3986). <br /></td></tr>
<tr class="separator:a4aa2a021ff974a4f832114cb2ac78875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8db8250d9d8d232bbaba5e76786f923" id="r_af8db8250d9d8d232bbaba5e76786f923"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#af8db8250d9d8d232bbaba5e76786f923">iceberg::rest::DecodeString</a> (std::string_view str_to_decode)</td></tr>
<tr class="memdesc:af8db8250d9d8d232bbaba5e76786f923"><td class="mdescLeft">&#160;</td><td class="mdescRight">URL-decode a string. <br /></td></tr>
<tr class="separator:af8db8250d9d8d232bbaba5e76786f923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b076e7237689480d7f48a0d2366cc45" id="r_a2b076e7237689480d7f48a0d2366cc45"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#a2b076e7237689480d7f48a0d2366cc45">iceberg::rest::EncodeNamespace</a> (const <a class="el" href="structiceberg_1_1Namespace.html">Namespace</a> &amp;ns_to_encode, std::string_view separator=&quot;%1F&quot;)</td></tr>
<tr class="memdesc:a2b076e7237689480d7f48a0d2366cc45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a <a class="el" href="structiceberg_1_1Namespace.html" title="A namespace in a catalog.">Namespace</a> into a URL-safe component. <br /></td></tr>
<tr class="separator:a2b076e7237689480d7f48a0d2366cc45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5badd007c81acc36f91204ad5da86876" id="r_a5badd007c81acc36f91204ad5da86876"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT <a class="el" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result</a>&lt; <a class="el" href="structiceberg_1_1Namespace.html">Namespace</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#a5badd007c81acc36f91204ad5da86876">iceberg::rest::DecodeNamespace</a> (std::string_view str_to_decode, std::string_view separator=&quot;%1F&quot;)</td></tr>
<tr class="memdesc:a5badd007c81acc36f91204ad5da86876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode a URL-encoded namespace string back to a <a class="el" href="structiceberg_1_1Namespace.html" title="A namespace in a catalog.">Namespace</a>. <br /></td></tr>
<tr class="separator:a5badd007c81acc36f91204ad5da86876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0410c454add87a8a7dc841ae7e0b6586" id="r_a0410c454add87a8a7dc841ae7e0b6586"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT std::unordered_map&lt; std::string, std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#a0410c454add87a8a7dc841ae7e0b6586">iceberg::rest::MergeConfigs</a> (const std::unordered_map&lt; std::string, std::string &gt; &amp;server_defaults, const std::unordered_map&lt; std::string, std::string &gt; &amp;client_configs, const std::unordered_map&lt; std::string, std::string &gt; &amp;server_overrides)</td></tr>
<tr class="memdesc:a0410c454add87a8a7dc841ae7e0b6586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Merge catalog configuration properties. <br /></td></tr>
<tr class="separator:a0410c454add87a8a7dc841ae7e0b6586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab34f165440087d8de6a5ab9d321c6682" id="r_ab34f165440087d8de6a5ab9d321c6682"><td class="memItemLeft" align="right" valign="top">ICEBERG_REST_EXPORT std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1rest.html#ab34f165440087d8de6a5ab9d321c6682">iceberg::rest::GetStandardReasonPhrase</a> (int32_t status_code)</td></tr>
<tr class="memdesc:ab34f165440087d8de6a5ab9d321c6682"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the standard HTTP reason phrase for a status code. <br /></td></tr>
<tr class="separator:ab34f165440087d8de6a5ab9d321c6682"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provide utilities for REST catalog path and config handling. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>