This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/docs/return__types__easy_8hpp_so...

66 lines
16 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: src/easy/return_types_easy.hpp 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="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
&#160;<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&amp;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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9d328871126a6a5820f3cd5c0c41741e.html">easy</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">return_types_easy.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* This file is part of mastodon-cpp.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright © 2019 tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * it under the terms of the GNU Affero General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the Free Software Foundation, version 3.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * GNU Affero General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * You should have received a copy of the GNU Affero General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef MASTODON_CPP_EASY_RETURN_TYPES_EASY_HPP</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define MASTODON_CPP_EASY_RETURN_TYPES_EASY_HPP</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;ostream&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;../mastodon-cpp.hpp&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">using</span> std::string;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">using</span> std::vector;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">using</span> std::uint8_t;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceMastodon.html">Mastodon</a></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">namespace </span>Easy</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structMastodon_1_1Easy_1_1return__entity.html"> 40</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structMastodon_1_1Easy_1_1return__entity.html">return_entity</a> : <a class="code" href="structMastodon_1_1return__base.html">return_base</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structMastodon_1_1Easy_1_1return__entity.html#a15c6011b041874d48282127c91961737"> 47</a></span>&#160; T <a class="code" href="structMastodon_1_1Easy_1_1return__entity.html#a15c6011b041874d48282127c91961737">entity</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="structMastodon_1_1Easy_1_1return__entity.html">return_entity</a>();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="structMastodon_1_1Easy_1_1return__entity.html">return_entity</a>(<span class="keyword">const</span> uint8_t ec, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;em,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">const</span> uint16_t hec, <span class="keyword">const</span> T &amp;ent);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="structMastodon_1_1Easy_1_1return__entity.html">return_entity</a>(<span class="keyword">const</span> error ec, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;em,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> uint16_t hec, <span class="keyword">const</span> T &amp;ent);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">operator</span> <span class="keyword">const</span> T() <span class="keyword">const</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keyword">operator</span> <span class="keyword">const</span> string() <span class="keyword">const</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="structMastodon_1_1Easy_1_1return__entity.html#a6fbabf54142d1cd8d2a29b5fae63df09"> 96</a></span>&#160; <span class="keyword">friend</span> std::ostream &amp;<a class="code" href="structMastodon_1_1Easy_1_1return__entity.html#a6fbabf54142d1cd8d2a29b5fae63df09">operator &lt;&lt;</a>(std::ostream &amp;out,</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keyword">const</span> <a class="code" href="structMastodon_1_1Easy_1_1return__entity.html">return_entity&lt;T&gt;</a> &amp;ret)</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="comment">// Could only get it to work by implementing it here.</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; out &lt;&lt; ret.<a class="code" href="structMastodon_1_1Easy_1_1return__entity.html#a15c6011b041874d48282127c91961737">entity</a>.to_string();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordflow">return</span> out;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; }</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; };</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="structMastodon_1_1Easy_1_1return__entity__vector.html"> 111</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structMastodon_1_1Easy_1_1return__entity__vector.html">return_entity_vector</a> : <a class="code" href="structMastodon_1_1return__base.html">return_base</a></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; {</div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="structMastodon_1_1Easy_1_1return__entity__vector.html#aca77975d214f743c0d20ea148be809ef"> 118</a></span>&#160; vector&lt;T&gt; <a class="code" href="structMastodon_1_1Easy_1_1return__entity__vector.html#aca77975d214f743c0d20ea148be809ef">entities</a>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="structMastodon_1_1Easy_1_1return__entity__vector.html">return_entity_vector</a>();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <a class="code" href="structMastodon_1_1Easy_1_1return__entity__vector.html">return_entity_vector</a>(<span class="keyword">const</span> uint8_t ec, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;em,</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">const</span> uint16_t hec, <span class="keyword">const</span> vector&lt;T&gt; &amp;vec);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keyword">operator</span> <span class="keyword">const</span> vector&lt;T&gt;() <span class="keyword">const</span>;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; };</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;}</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;}</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="preprocessor">#endif // MASTODON_CPP_EASY_RETURN_TYPES_EASY_HPP</span></div><div class="ttc" id="structMastodon_1_1Easy_1_1return__entity_html_a6fbabf54142d1cd8d2a29b5fae63df09"><div class="ttname"><a href="structMastodon_1_1Easy_1_1return__entity.html#a6fbabf54142d1cd8d2a29b5fae63df09">Mastodon::Easy::return_entity::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;out, const return_entity&lt; T &gt; &amp;ret)</div><div class="ttdoc">Mastodon::Easy::Entity as formatted string.</div><div class="ttdef"><b>Definition:</b> return_types_easy.hpp:96</div></div>
<div class="ttc" id="structMastodon_1_1Easy_1_1return__entity_html_a15c6011b041874d48282127c91961737"><div class="ttname"><a href="structMastodon_1_1Easy_1_1return__entity.html#a15c6011b041874d48282127c91961737">Mastodon::Easy::return_entity::entity</a></div><div class="ttdeci">T entity</div><div class="ttdoc">Mastodon::Easy::Entity.</div><div class="ttdef"><b>Definition:</b> return_types_easy.hpp:47</div></div>
<div class="ttc" id="structMastodon_1_1Easy_1_1return__entity__vector_html"><div class="ttname"><a href="structMastodon_1_1Easy_1_1return__entity__vector.html">Mastodon::Easy::return_entity_vector</a></div><div class="ttdoc">Return types for calls that return multiple Easy::Entitys.</div><div class="ttdef"><b>Definition:</b> return_types_easy.hpp:111</div></div>
<div class="ttc" id="namespaceMastodon_html"><div class="ttname"><a href="namespaceMastodon.html">Mastodon</a></div><div class="ttdoc">Collection of things to interface with server software that implements the Mastodon API.</div><div class="ttdef"><b>Definition:</b> mastodon-cpp.hpp:47</div></div>
<div class="ttc" id="structMastodon_1_1Easy_1_1return__entity_html"><div class="ttname"><a href="structMastodon_1_1Easy_1_1return__entity.html">Mastodon::Easy::return_entity</a></div><div class="ttdoc">Return types for calls that return a single Easy::Entity.</div><div class="ttdef"><b>Definition:</b> return_types_easy.hpp:40</div></div>
<div class="ttc" id="structMastodon_1_1return__base_html"><div class="ttname"><a href="structMastodon_1_1return__base.html">Mastodon::return_base</a></div><div class="ttdoc">Basis for return types.</div><div class="ttdef"><b>Definition:</b> return_types.hpp:35</div></div>
<div class="ttc" id="structMastodon_1_1Easy_1_1return__entity__vector_html_aca77975d214f743c0d20ea148be809ef"><div class="ttname"><a href="structMastodon_1_1Easy_1_1return__entity__vector.html#aca77975d214f743c0d20ea148be809ef">Mastodon::Easy::return_entity_vector::entities</a></div><div class="ttdeci">vector&lt; T &gt; entities</div><div class="ttdoc">std::vector of Mastodon::Easy::Entity.</div><div class="ttdef"><b>Definition:</b> return_types_easy.hpp:118</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>