| <!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 Source File</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&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&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="headertitle"><div class="title">rest_util.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="rest__util_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <string></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <unordered_map></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <unordered_set></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "<a class="code" href="endpoint_8h.html">iceberg/catalog/rest/endpoint.h</a>"</span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="iceberg__rest__export_8h.html">iceberg/catalog/rest/iceberg_rest_export.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include "<a class="code" href="catalog_2rest_2type__fwd_8h.html">iceberg/catalog/rest/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include "<a class="code" href="result_8h.html">iceberg/result.h</a>"</span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="type__fwd_8h.html">iceberg/type_fwd.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg_1_1rest.html">iceberg::rest</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#adb65e3a4660c8f4208bafcf640871049"> 42</a></span>ICEBERG_REST_EXPORT std::string_view <a class="code hl_function" href="namespaceiceberg_1_1rest.html#adb65e3a4660c8f4208bafcf640871049">TrimTrailingSlash</a>(std::string_view str);</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#a4aa2a021ff974a4f832114cb2ac78875"> 52</a></span>ICEBERG_REST_EXPORT <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::string></a> <a class="code hl_function" href="namespaceiceberg_1_1rest.html#a4aa2a021ff974a4f832114cb2ac78875">EncodeString</a>(std::string_view str_to_encode);</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#af8db8250d9d8d232bbaba5e76786f923"> 60</a></span>ICEBERG_REST_EXPORT <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::string></a> <a class="code hl_function" href="namespaceiceberg_1_1rest.html#af8db8250d9d8d232bbaba5e76786f923">DecodeString</a>(std::string_view str_to_decode);</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#a2b076e7237689480d7f48a0d2366cc45"> 69</a></span>ICEBERG_REST_EXPORT <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<std::string></a> <a class="code hl_function" href="namespaceiceberg_1_1rest.html#a2b076e7237689480d7f48a0d2366cc45">EncodeNamespace</a>(</div> |
| <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">const</span> <a class="code hl_struct" href="structiceberg_1_1Namespace.html">Namespace</a>& ns_to_encode, std::string_view separator = <span class="stringliteral">"%1F"</span>);</div> |
| <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#a5badd007c81acc36f91204ad5da86876"> 79</a></span>ICEBERG_REST_EXPORT <a class="code hl_typedef" href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">Result<Namespace></a> <a class="code hl_function" href="namespaceiceberg_1_1rest.html#a5badd007c81acc36f91204ad5da86876">DecodeNamespace</a>(std::string_view str_to_decode,</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> std::string_view separator = <span class="stringliteral">"%1F"</span>);</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#a0410c454add87a8a7dc841ae7e0b6586"> 90</a></span>ICEBERG_REST_EXPORT std::unordered_map<std::string, std::string> <a class="code hl_function" href="namespaceiceberg_1_1rest.html#a0410c454add87a8a7dc841ae7e0b6586">MergeConfigs</a>(</div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& server_defaults,</div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& client_configs,</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">const</span> std::unordered_map<std::string, std::string>& server_overrides);</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="namespaceiceberg_1_1rest.html#ab34f165440087d8de6a5ab9d321c6682"> 102</a></span>ICEBERG_REST_EXPORT std::string <a class="code hl_function" href="namespaceiceberg_1_1rest.html#ab34f165440087d8de6a5ab9d321c6682">GetStandardReasonPhrase</a>(int32_t status_code);</div> |
| <div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span>} <span class="comment">// namespace iceberg::rest</span></div> |
| <div class="ttc" id="acatalog_2rest_2type__fwd_8h_html"><div class="ttname"><a href="catalog_2rest_2type__fwd_8h.html">type_fwd.h</a></div></div> |
| <div class="ttc" id="aendpoint_8h_html"><div class="ttname"><a href="endpoint_8h.html">endpoint.h</a></div></div> |
| <div class="ttc" id="aiceberg__rest__export_8h_html"><div class="ttname"><a href="iceberg__rest__export_8h.html">iceberg_rest_export.h</a></div><div class="ttdoc">Define symbol visibility macros for the REST catalog library.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html"><div class="ttname"><a href="namespaceiceberg_1_1rest.html">iceberg::rest</a></div><div class="ttdoc">REST catalog APIs.</div><div class="ttdef"><b>Definition</b> auth_manager.h:34</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_a0410c454add87a8a7dc841ae7e0b6586"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#a0410c454add87a8a7dc841ae7e0b6586">iceberg::rest::MergeConfigs</a></div><div class="ttdeci">ICEBERG_REST_EXPORT std::unordered_map< std::string, std::string > MergeConfigs(const std::unordered_map< std::string, std::string > &server_defaults, const std::unordered_map< std::string, std::string > &client_configs, const std::unordered_map< std::string, std::string > &server_overrides)</div><div class="ttdoc">Merge catalog configuration properties.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_a2b076e7237689480d7f48a0d2366cc45"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#a2b076e7237689480d7f48a0d2366cc45">iceberg::rest::EncodeNamespace</a></div><div class="ttdeci">ICEBERG_REST_EXPORT Result< std::string > EncodeNamespace(const Namespace &ns_to_encode, std::string_view separator="%1F")</div><div class="ttdoc">Encode a Namespace into a URL-safe component.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_a4aa2a021ff974a4f832114cb2ac78875"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#a4aa2a021ff974a4f832114cb2ac78875">iceberg::rest::EncodeString</a></div><div class="ttdeci">ICEBERG_REST_EXPORT Result< std::string > EncodeString(std::string_view str_to_encode)</div><div class="ttdoc">URL-encode a string (RFC 3986).</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_a5badd007c81acc36f91204ad5da86876"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#a5badd007c81acc36f91204ad5da86876">iceberg::rest::DecodeNamespace</a></div><div class="ttdeci">ICEBERG_REST_EXPORT Result< Namespace > DecodeNamespace(std::string_view str_to_decode, std::string_view separator="%1F")</div><div class="ttdoc">Decode a URL-encoded namespace string back to a Namespace.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_ab34f165440087d8de6a5ab9d321c6682"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#ab34f165440087d8de6a5ab9d321c6682">iceberg::rest::GetStandardReasonPhrase</a></div><div class="ttdeci">ICEBERG_REST_EXPORT std::string GetStandardReasonPhrase(int32_t status_code)</div><div class="ttdoc">Get the standard HTTP reason phrase for a status code.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_adb65e3a4660c8f4208bafcf640871049"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#adb65e3a4660c8f4208bafcf640871049">iceberg::rest::TrimTrailingSlash</a></div><div class="ttdeci">ICEBERG_REST_EXPORT std::string_view TrimTrailingSlash(std::string_view str)</div><div class="ttdoc">Trim trailing slashes from a string.</div></div> |
| <div class="ttc" id="anamespaceiceberg_1_1rest_html_af8db8250d9d8d232bbaba5e76786f923"><div class="ttname"><a href="namespaceiceberg_1_1rest.html#af8db8250d9d8d232bbaba5e76786f923">iceberg::rest::DecodeString</a></div><div class="ttdeci">ICEBERG_REST_EXPORT Result< std::string > DecodeString(std::string_view str_to_decode)</div><div class="ttdoc">URL-decode a string.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a9d5594e371beb516b0120e07e69d3af6"><div class="ttname"><a href="namespaceiceberg.html#a9d5594e371beb516b0120e07e69d3af6">iceberg::Result</a></div><div class="ttdeci">std::expected< T, E > Result</div><div class="ttdoc">Result alias.</div><div class="ttdef"><b>Definition</b> result.h:88</div></div> |
| <div class="ttc" id="aresult_8h_html"><div class="ttname"><a href="result_8h.html">result.h</a></div><div class="ttdoc">Define Result, Status, and error helpers.</div></div> |
| <div class="ttc" id="astructiceberg_1_1Namespace_html"><div class="ttname"><a href="structiceberg_1_1Namespace.html">iceberg::Namespace</a></div><div class="ttdoc">A namespace in a catalog.</div><div class="ttdef"><b>Definition</b> table_identifier.h:35</div></div> |
| <div class="ttc" id="atype__fwd_8h_html"><div class="ttname"><a href="type__fwd_8h.html">type_fwd.h</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
