blob: 5bdfccb6fff90b6d9d3d0a6d90fecb04fd406089 [file] [log] [blame]
<!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::TransformUtil Class 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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1TransformUtil.html">TransformUtil</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1TransformUtil-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::TransformUtil Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9e5317a2b55d0b9d64a13ab9510b6ce3" id="r_a9e5317a2b55d0b9d64a13ab9510b6ce3"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#a9e5317a2b55d0b9d64a13ab9510b6ce3">HumanYear</a> (int32_t year)</td></tr>
<tr class="memdesc:a9e5317a2b55d0b9d64a13ab9510b6ce3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a human-readable string for a year. <br /></td></tr>
<tr class="separator:a9e5317a2b55d0b9d64a13ab9510b6ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f3a5607a2e2b5edce632fbbc22e76af" id="r_a4f3a5607a2e2b5edce632fbbc22e76af"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#a4f3a5607a2e2b5edce632fbbc22e76af">HumanMonth</a> (int32_t month)</td></tr>
<tr class="memdesc:a4f3a5607a2e2b5edce632fbbc22e76af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a human-readable string for a month. <br /></td></tr>
<tr class="separator:a4f3a5607a2e2b5edce632fbbc22e76af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af63c12a708200acf8c579916bf687d95" id="r_af63c12a708200acf8c579916bf687d95"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#af63c12a708200acf8c579916bf687d95">HumanDay</a> (int32_t day_ordinal)</td></tr>
<tr class="memdesc:af63c12a708200acf8c579916bf687d95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a human-readable string for the given day ordinal. <br /></td></tr>
<tr class="separator:af63c12a708200acf8c579916bf687d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5737dcb152c45aab8e67ba7aed0e38e0" id="r_a5737dcb152c45aab8e67ba7aed0e38e0"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#a5737dcb152c45aab8e67ba7aed0e38e0">HumanHour</a> (int32_t hour_ordinal)</td></tr>
<tr class="memdesc:a5737dcb152c45aab8e67ba7aed0e38e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a human-readable string for the given hour ordinal. <br /></td></tr>
<tr class="separator:a5737dcb152c45aab8e67ba7aed0e38e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6316ac666a48e161265326f2ffb4f2c1" id="r_a6316ac666a48e161265326f2ffb4f2c1"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#a6316ac666a48e161265326f2ffb4f2c1">HumanTime</a> (int64_t micros_from_midnight)</td></tr>
<tr class="memdesc:a6316ac666a48e161265326f2ffb4f2c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outputs this time as a String, such as 10:15. <br /></td></tr>
<tr class="separator:a6316ac666a48e161265326f2ffb4f2c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a972354a52e40d336f46b83771526e912" id="r_a972354a52e40d336f46b83771526e912"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#a972354a52e40d336f46b83771526e912">HumanTimestamp</a> (int64_t timestamp_micros)</td></tr>
<tr class="memdesc:a972354a52e40d336f46b83771526e912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string representation of a timestamp in microseconds. <br /></td></tr>
<tr class="separator:a972354a52e40d336f46b83771526e912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af34308c5bd43562588b0dde9a28e4fc4" id="r_af34308c5bd43562588b0dde9a28e4fc4"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1TransformUtil.html#af34308c5bd43562588b0dde9a28e4fc4">HumanTimestampWithZone</a> (int64_t timestamp_micros)</td></tr>
<tr class="memdesc:af34308c5bd43562588b0dde9a28e4fc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a human-readable string representation of a timestamp with a time zone. <br /></td></tr>
<tr class="separator:af34308c5bd43562588b0dde9a28e4fc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9b9b466b8f4d7877b79b23666c64523" id="r_ae9b9b466b8f4d7877b79b23666c64523"><td class="memItemLeft" align="right" valign="top"><a id="ae9b9b466b8f4d7877b79b23666c64523" name="ae9b9b466b8f4d7877b79b23666c64523"></a>
static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>Base64Encode</b> (std::string_view str_to_encode)</td></tr>
<tr class="memdesc:ae9b9b466b8f4d7877b79b23666c64523"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base64 encode a string. <br /></td></tr>
<tr class="separator:ae9b9b466b8f4d7877b79b23666c64523"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af63c12a708200acf8c579916bf687d95" name="af63c12a708200acf8c579916bf687d95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af63c12a708200acf8c579916bf687d95">&#9670;&#160;</a></span>HumanDay()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanDay </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>day_ordinal</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a human-readable string for the given day ordinal. </p>
<p>The string is formatted as: <code>yyyy-MM-dd</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">day_ordinal</td><td>The day ordinal. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A human-readable string for the given day ordinal. </dd></dl>
</div>
</div>
<a id="a5737dcb152c45aab8e67ba7aed0e38e0" name="a5737dcb152c45aab8e67ba7aed0e38e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5737dcb152c45aab8e67ba7aed0e38e0">&#9670;&#160;</a></span>HumanHour()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanHour </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>hour_ordinal</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a human-readable string for the given hour ordinal. </p>
<p>The string is formatted as: <code>yyyy-MM-dd-HH</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hour_ordinal</td><td>The hour ordinal. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A human-readable string for the given hour ordinal. </dd></dl>
</div>
</div>
<a id="a4f3a5607a2e2b5edce632fbbc22e76af" name="a4f3a5607a2e2b5edce632fbbc22e76af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f3a5607a2e2b5edce632fbbc22e76af">&#9670;&#160;</a></span>HumanMonth()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanMonth </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>month</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a human-readable string for a month. </p>
<p>The string is formatted as "yyyy-MM".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">month</td><td>The month to format. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A human-readable string for the month. </dd></dl>
</div>
</div>
<a id="a6316ac666a48e161265326f2ffb4f2c1" name="a6316ac666a48e161265326f2ffb4f2c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6316ac666a48e161265326f2ffb4f2c1">&#9670;&#160;</a></span>HumanTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanTime </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>micros_from_midnight</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Outputs this time as a String, such as 10:15. </p>
<p>The output will be one of the following ISO-8601 formats: HH:mm HH:mm:ss HH:mm:ss.SSS HH:mm:ss.SSSSSS The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">microseconds_from_midnight</td><td>the time in microseconds from midnight </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string representation of this time </dd></dl>
</div>
</div>
<a id="a972354a52e40d336f46b83771526e912" name="a972354a52e40d336f46b83771526e912"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a972354a52e40d336f46b83771526e912">&#9670;&#160;</a></span>HumanTimestamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanTimestamp </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>timestamp_micros</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representation of a timestamp in microseconds. </p>
<p>The output will be one of the following forms, according to the precision of the timestamp:</p><ul>
<li>yyyy-MM-ddTHH:mm:ss</li>
<li>yyyy-MM-ddTHH:mm:ss.SSS</li>
<li>yyyy-MM-ddTHH:mm:ss.SSSSSS</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timestamp_micros</td><td>the timestamp in microseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string representation of this timestamp. </dd></dl>
</div>
</div>
<a id="af34308c5bd43562588b0dde9a28e4fc4" name="af34308c5bd43562588b0dde9a28e4fc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af34308c5bd43562588b0dde9a28e4fc4">&#9670;&#160;</a></span>HumanTimestampWithZone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanTimestampWithZone </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>timestamp_micros</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a human-readable string representation of a timestamp with a time zone. </p>
<p>The output will be one of the following forms, according to the precision of the timestamp:</p><ul>
<li>yyyy-MM-ddTHH:mm:ss+00:00</li>
<li>yyyy-MM-ddTHH:mm:ss.SSS+00:00</li>
<li>yyyy-MM-ddTHH:mm:ss.SSSSSS+00:00</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timestamp_micros</td><td>the timestamp in microseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a string representation of this timestamp. </dd></dl>
</div>
</div>
<a id="a9e5317a2b55d0b9d64a13ab9510b6ce3" name="a9e5317a2b55d0b9d64a13ab9510b6ce3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e5317a2b55d0b9d64a13ab9510b6ce3">&#9670;&#160;</a></span>HumanYear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::TransformUtil::HumanYear </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>year</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a human-readable string for a year. </p>
<p>The string is formatted as "yyyy".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">year</td><td>The year to format. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A human-readable string for the year. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/util/<a class="el" href="transform__util_8h_source.html">transform_util.h</a></li>
<li>iceberg/util/<b>transform_util.cc</b></li>
</ul>
</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>