205 lines
14 KiB
HTML
205 lines
14 KiB
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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>mastodon-cpp: Mastodon::Easy::time_type Struct 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="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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">mastodon-cpp
|
|
 <span id="projectnumber">0.110.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceMastodon.html">Mastodon</a></li><li class="navelem"><a class="el" href="namespaceMastodon_1_1Easy.html">Easy</a></li><li class="navelem"><a class="el" href="structMastodon_1_1Easy_1_1time__type.html">time_type</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="structMastodon_1_1Easy_1_1time__type-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Mastodon::Easy::time_type Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Type for time. Converts to time_point and string.
|
|
<a href="structMastodon_1_1Easy_1_1time__type.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="types__easy_8hpp_source.html">types_easy.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae6622dec6af28f7346e7d539d7cc2b6a"><td class="memItemLeft" align="right" valign="top"><a id="ae6622dec6af28f7346e7d539d7cc2b6a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>operator const system_clock::time_point</b> () const</td></tr>
|
|
<tr class="separator:ae6622dec6af28f7346e7d539d7cc2b6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd05b9cabe9c1b86ba518f222548bcf7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1time__type.html#abd05b9cabe9c1b86ba518f222548bcf7">operator const string</a> () const</td></tr>
|
|
<tr class="memdesc:abd05b9cabe9c1b86ba518f222548bcf7"><td class="mdescLeft"> </td><td class="mdescRight">Returns local time as string in ISO 8601 format (FTTz). <a href="#abd05b9cabe9c1b86ba518f222548bcf7">More...</a><br /></td></tr>
|
|
<tr class="separator:abd05b9cabe9c1b86ba518f222548bcf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50770addeaf2a00e6541393c732d9284"><td class="memItemLeft" align="right" valign="top">const string </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1time__type.html#a50770addeaf2a00e6541393c732d9284">strtime</a> (const string &format, const bool &local=true) const</td></tr>
|
|
<tr class="memdesc:a50770addeaf2a00e6541393c732d9284"><td class="mdescLeft"> </td><td class="mdescRight">Converts time to a string. <a href="#a50770addeaf2a00e6541393c732d9284">More...</a><br /></td></tr>
|
|
<tr class="separator:a50770addeaf2a00e6541393c732d9284"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ac03d29b214d952dc6d4769ad64af8c26"><td class="memItemLeft" align="right" valign="top"><a id="ac03d29b214d952dc6d4769ad64af8c26"></a>
|
|
system_clock::time_point </td><td class="memItemRight" valign="bottom"><b>timepoint</b> = system_clock::time_point()</td></tr>
|
|
<tr class="separator:ac03d29b214d952dc6d4769ad64af8c26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:ae5dc86ac88b67c96e59a3f724ccbe291"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="structMastodon_1_1Easy_1_1time__type.html#ae5dc86ac88b67c96e59a3f724ccbe291">operator<<</a> (std::ostream &out, const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">Easy::time_type</a> &t)</td></tr>
|
|
<tr class="memdesc:ae5dc86ac88b67c96e59a3f724ccbe291"><td class="mdescLeft"> </td><td class="mdescRight">Returns local time as string in ISO 8601 format (FTTz). <a href="#ae5dc86ac88b67c96e59a3f724ccbe291">More...</a><br /></td></tr>
|
|
<tr class="separator:ae5dc86ac88b67c96e59a3f724ccbe291"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Type for time. Converts to time_point and string. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="abd05b9cabe9c1b86ba518f222548bcf7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd05b9cabe9c1b86ba518f222548bcf7">◆ </a></span>operator const string()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Mastodon::Easy::time_type::operator const string </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns local time as string in ISO 8601 format (FTTz). </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> <a class="code" href="structMastodon_1_1Easy_1_1time__type.html#a50770addeaf2a00e6541393c732d9284">strtime</a>(<span class="stringliteral">"%FT%T%z"</span>, <span class="keyword">true</span>);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</div><div class="ttc" id="structMastodon_1_1Easy_1_1time__type_html_a50770addeaf2a00e6541393c732d9284"><div class="ttname"><a href="structMastodon_1_1Easy_1_1time__type.html#a50770addeaf2a00e6541393c732d9284">Mastodon::Easy::time_type::strtime</a></div><div class="ttdeci">const string strtime(const string &format, const bool &local=true) const</div><div class="ttdoc">Converts time to a string.</div><div class="ttdef"><b>Definition:</b> types_easy.cpp:33</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="a50770addeaf2a00e6541393c732d9284"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50770addeaf2a00e6541393c732d9284">◆ </a></span>strtime()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const string Mastodon::Easy::time_type::strtime </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const string & </td>
|
|
<td class="paramname"><em>format</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool & </td>
|
|
<td class="paramname"><em>local</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Converts time to a string. </p>
|
|
<pre class="fragment"> The return value can not exceed 1023 chars.
|
|
</pre><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">format</td><td>The format of the string, same as with <code>strftime</code>. </td></tr>
|
|
<tr><td class="paramname">local</td><td>Use local time (default) or UTC.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Example: </p><div class="fragment"><div class="line"><a class="code" href="structMastodon_1_1Easy_1_1time__type.html">Mastodon::Easy::time</a> timepoint = status.created_at();</div><div class="line">std::cout << timepoint.<a class="code" href="structMastodon_1_1Easy_1_1time__type.html#a50770addeaf2a00e6541393c732d9284">strtime</a>(<span class="stringliteral">"%F, %T UTC"</span>, <span class="keyword">false</span>) << <span class="charliteral">'\n'</span>;</div></div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The time as string.</dd></dl>
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="example02_stream_8cpp-example.html#a6">example02_stream.cpp</a>.</dd>
|
|
</dl>
|
|
<div class="fragment"><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  constexpr std::uint16_t bufsize = 1024;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  std::time_t time = system_clock::to_time_t(timepoint);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::tm *tm;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">if</span> (local)</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  tm = std::localtime(&time);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  tm = std::gmtime(&time);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">char</span> buffer[bufsize];</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::strftime(buffer, bufsize, format.c_str(), tm);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> static_cast<const string>(buffer);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
|
<a id="ae5dc86ac88b67c96e59a3f724ccbe291"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5dc86ac88b67c96e59a3f724ccbe291">◆ </a></span>operator<<</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ostream& operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream & </td>
|
|
<td class="paramname"><em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structMastodon_1_1Easy_1_1time__type.html">Easy::time_type</a> & </td>
|
|
<td class="paramname"><em>t</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns local time as string in ISO 8601 format (FTTz). </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.100.0 </dd></dl>
|
|
<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> <span class="keywordtype">string</span> s = t; <span class="comment">// Converts using operator const string().</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  out << s;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> out;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>src/easy/<a class="el" href="types__easy_8hpp_source.html">types_easy.hpp</a></li>
|
|
<li>src/easy/types_easy.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|