mkdocs/docs/api/s3__properties_8h.html - iceberg-cpp - Git at Google

 <!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/arrow/s3/s3_properties.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_b7cf026d9e3f55cae42b23722c36a1cb.html">arrow</a></li><li class="navelem"><a class="el" href="dir_b30515858f540bdd12c1f82074ea4abe.html">s3</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#namespaces">Namespaces</a> &#124;
 <a href="#func-members">Functions</a> &#124;
 <a href="#var-members">Variables</a>  </div>
   <div class="headertitle"><div class="title">s3_properties.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">

 <p>Define S3 configuration property keys.
 <a href="#details">More...</a></p>
 <div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
 <code>#include &lt;array&gt;</code><br />
 <code>#include &lt;string_view&gt;</code><br />
 </div>
 <p><a href="s3__properties_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="nested-classes" name="nested-classes"></a>
 Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1arrow_1_1S3Properties.html">iceberg::arrow::S3Properties</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">S3 configuration property keys for ArrowS3FileIO.  <a href="structiceberg_1_1arrow_1_1S3Properties.html#details">More...</a><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="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_1arrow" id="r_namespaceiceberg_1_1arrow"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html">iceberg::arrow</a></td></tr>
 <tr class="memdesc:namespaceiceberg_1_1arrow"><td class="mdescLeft">&#160;</td><td class="mdescRight">Arrow-backed IO and data conversion 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:aed8332d01e16aeb3ca8c55f222856ae0" id="r_aed8332d01e16aeb3ca8c55f222856ae0"><td class="memItemLeft" align="right" valign="top"><a id="aed8332d01e16aeb3ca8c55f222856ae0" name="aed8332d01e16aeb3ca8c55f222856ae0"></a>
 constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::EqualsIgnoreAsciiCase</b> (std::string_view left, std::string_view right)</td></tr>
 <tr class="memdesc:aed8332d01e16aeb3ca8c55f222856ae0"><td class="mdescLeft">&#160;</td><td class="mdescRight">ASCII-only case-insensitive comparison: schemes are ASCII (RFC 3986), and &lt;cctype&gt; is locale-sensitive. <br /></td></tr>
 <tr class="separator:aed8332d01e16aeb3ca8c55f222856ae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af7361a309535725b457d956293b33c76" id="r_af7361a309535725b457d956293b33c76"><td class="memItemLeft" align="right" valign="top"><a id="af7361a309535725b457d956293b33c76" name="af7361a309535725b457d956293b33c76"></a>
 constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::IsS3Scheme</b> (std::string_view scheme)</td></tr>
 <tr class="memdesc:af7361a309535725b457d956293b33c76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether a URI scheme is S3-compatible; case-insensitive, because scheme routing is. <br /></td></tr>
 <tr class="separator:af7361a309535725b457d956293b33c76"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a022f2be841411f9ebbe5f777ef82e588" id="r_a022f2be841411f9ebbe5f777ef82e588"><td class="memItemLeft" align="right" valign="top">constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#a022f2be841411f9ebbe5f777ef82e588">iceberg::arrow::IsS3CredentialPrefix</a> (std::string_view prefix)</td></tr>
 <tr class="memdesc:a022f2be841411f9ebbe5f777ef82e588"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return whether a storage credential prefix belongs to S3.  <br /></td></tr>
 <tr class="separator:a022f2be841411f9ebbe5f777ef82e588"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
 Variables</h2></td></tr>
 <tr class="memitem:a4dc2f2056c520e55520c47f2c6b94b37" id="r_a4dc2f2056c520e55520c47f2c6b94b37"><td class="memItemLeft" align="right" valign="top">constexpr std::array&lt; std::string_view, 4 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#a4dc2f2056c520e55520c47f2c6b94b37">iceberg::arrow::kS3Schemes</a> = {&quot;s3&quot;, &quot;s3a&quot;, &quot;s3n&quot;, &quot;oss&quot;}</td></tr>
 <tr class="memdesc:a4dc2f2056c520e55520c47f2c6b94b37"><td class="mdescLeft">&#160;</td><td class="mdescRight">URI schemes served by the Arrow S3 <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a>, lower-case.  <br /></td></tr>
 <tr class="separator:a4dc2f2056c520e55520c47f2c6b94b37"><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>Define S3 configuration property keys. </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>
	<!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/arrow/s3/s3_properties.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&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>
	<!-- 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_b7cf026d9e3f55cae42b23722c36a1cb.html">arrow</a></li><li class="navelem"><a class="el" href="dir_b30515858f540bdd12c1f82074ea4abe.html">s3</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#nested-classes">Classes</a> \|
	<a href="#namespaces">Namespaces</a> \|
	<a href="#func-members">Functions</a> \|
	<a href="#var-members">Variables</a> </div>
	<div class="headertitle"><div class="title">s3_properties.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">

	<p>Define S3 configuration property keys.
	<a href="#details">More...</a></p>
	<div class="textblock"><code>#include <algorithm></code><br />
	<code>#include <array></code><br />
	<code>#include <string_view></code><br />
	</div>
	<p><a href="s3__properties_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="nested-classes" name="nested-classes"></a>
	Classes</h2></td></tr>
	<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structiceberg_1_1arrow_1_1S3Properties.html">iceberg::arrow::S3Properties</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">S3 configuration property keys for ArrowS3FileIO. <a href="structiceberg_1_1arrow_1_1S3Properties.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	</table><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  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg.html">iceberg</a></td></tr>
	<tr class="memdesc:namespaceiceberg"><td class="mdescLeft"> </td><td class="mdescRight">Core Apache Iceberg C++ APIs. <br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:namespaceiceberg_1_1arrow" id="r_namespaceiceberg_1_1arrow"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html">iceberg::arrow</a></td></tr>
	<tr class="memdesc:namespaceiceberg_1_1arrow"><td class="mdescLeft"> </td><td class="mdescRight">Arrow-backed IO and data conversion APIs. <br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </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:aed8332d01e16aeb3ca8c55f222856ae0" id="r_aed8332d01e16aeb3ca8c55f222856ae0"><td class="memItemLeft" align="right" valign="top"><a id="aed8332d01e16aeb3ca8c55f222856ae0" name="aed8332d01e16aeb3ca8c55f222856ae0"></a>
	constexpr bool </td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::EqualsIgnoreAsciiCase</b> (std::string_view left, std::string_view right)</td></tr>
	<tr class="memdesc:aed8332d01e16aeb3ca8c55f222856ae0"><td class="mdescLeft"> </td><td class="mdescRight">ASCII-only case-insensitive comparison: schemes are ASCII (RFC 3986), and <cctype> is locale-sensitive. <br /></td></tr>
	<tr class="separator:aed8332d01e16aeb3ca8c55f222856ae0"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:af7361a309535725b457d956293b33c76" id="r_af7361a309535725b457d956293b33c76"><td class="memItemLeft" align="right" valign="top"><a id="af7361a309535725b457d956293b33c76" name="af7361a309535725b457d956293b33c76"></a>
	constexpr bool </td><td class="memItemRight" valign="bottom"><b>iceberg::arrow::IsS3Scheme</b> (std::string_view scheme)</td></tr>
	<tr class="memdesc:af7361a309535725b457d956293b33c76"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a URI scheme is S3-compatible; case-insensitive, because scheme routing is. <br /></td></tr>
	<tr class="separator:af7361a309535725b457d956293b33c76"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:a022f2be841411f9ebbe5f777ef82e588" id="r_a022f2be841411f9ebbe5f777ef82e588"><td class="memItemLeft" align="right" valign="top">constexpr bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#a022f2be841411f9ebbe5f777ef82e588">iceberg::arrow::IsS3CredentialPrefix</a> (std::string_view prefix)</td></tr>
	<tr class="memdesc:a022f2be841411f9ebbe5f777ef82e588"><td class="mdescLeft"> </td><td class="mdescRight">Return whether a storage credential prefix belongs to S3. <br /></td></tr>
	<tr class="separator:a022f2be841411f9ebbe5f777ef82e588"><td class="memSeparator" colspan="2"> </td></tr>
	</table><table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
	Variables</h2></td></tr>
	<tr class="memitem:a4dc2f2056c520e55520c47f2c6b94b37" id="r_a4dc2f2056c520e55520c47f2c6b94b37"><td class="memItemLeft" align="right" valign="top">constexpr std::array< std::string_view, 4 > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceiceberg_1_1arrow.html#a4dc2f2056c520e55520c47f2c6b94b37">iceberg::arrow::kS3Schemes</a> = {"s3", "s3a", "s3n", "oss"}</td></tr>
	<tr class="memdesc:a4dc2f2056c520e55520c47f2c6b94b37"><td class="mdescLeft"> </td><td class="mdescRight">URI schemes served by the Arrow S3 <a class="el" href="classiceberg_1_1FileIO.html" title="Pluggable module for reading, writing, and deleting files.">FileIO</a>, lower-case. <br /></td></tr>
	<tr class="separator:a4dc2f2056c520e55520c47f2c6b94b37"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>Define S3 configuration property keys. </p>
	</div></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>