tastytea
/
mastodonpp
2
1
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity
mastodonpp/docs/structmastodonpp_1_1answer_...

463 lines
30 KiB
HTML
Raw Blame History

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mastodonpp: mastodonpp::answer_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="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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mastodonpp
&#160;<span id="projectnumber">0.5.7</span>
</div>
<div id="projectbrief">C++ wrapper for the Mastodon and Pleroma APIs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemastodonpp.html">mastodonpp</a></li><li class="navelem"><a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structmastodonpp_1_1answer__type-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mastodonpp::answer_type Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Return type for Requests.
<a href="structmastodonpp_1_1answer__type.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="types_8hpp_source.html">types.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mastodonpp::answer_type:</div>
<div class="dyncontent">
<div class="center"><img src="structmastodonpp_1_1answer__type__coll__graph.png" border="0" usemap="#mastodonpp_1_1answer__type_coll__map" alt="Collaboration graph"/></div>
<map name="mastodonpp_1_1answer__type_coll__map" id="mastodonpp_1_1answer__type_coll__map">
<area shape="rect" title="Return type for Requests." alt="" coords="52,215,227,241"/>
<area shape="rect" title=" " alt="" coords="5,96,73,123"/>
<area shape="rect" title=" " alt="" coords="109,96,170,123"/>
<area shape="rect" title="STL class." alt="" coords="223,96,303,123"/>
<area shape="rect" title="STL class." alt="" coords="200,5,327,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:aea7a4e100d215562a1d6b00524f99103"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#aea7a4e100d215562a1d6b00524f99103">operator bool</a> () const</td></tr>
<tr class="memdesc:aea7a4e100d215562a1d6b00524f99103"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if <a class="el" href="structmastodonpp_1_1answer__type.html#a7c5582c4500034c0ea36ab1694944139" title="The error code returned by libcurl.">curl_error_code</a> is 0 and <a class="el" href="structmastodonpp_1_1answer__type.html#a0716af5033e02551937187a149c3f52d" title="HTTP status code.">http_status</a> is 200, false otherwise. <a href="structmastodonpp_1_1answer__type.html#aea7a4e100d215562a1d6b00524f99103">More...</a><br /></td></tr>
<tr class="separator:aea7a4e100d215562a1d6b00524f99103"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c90b439bcf65b4a4a655e9213b14a0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a6c90b439bcf65b4a4a655e9213b14a0f">operator string_view</a> () const</td></tr>
<tr class="memdesc:a6c90b439bcf65b4a4a655e9213b14a0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38" title="The response from the server, usually JSON.">body</a> as <code>std::string_view</code>. <a href="structmastodonpp_1_1answer__type.html#a6c90b439bcf65b4a4a655e9213b14a0f">More...</a><br /></td></tr>
<tr class="separator:a6c90b439bcf65b4a4a655e9213b14a0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65f4ba85d95c15ebc07377a2b74959da"><td class="memItemLeft" align="right" valign="top">string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a65f4ba85d95c15ebc07377a2b74959da">get_header</a> (string_view field) const</td></tr>
<tr class="memdesc:a65f4ba85d95c15ebc07377a2b74959da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of a header field. <a href="structmastodonpp_1_1answer__type.html#a65f4ba85d95c15ebc07377a2b74959da">More...</a><br /></td></tr>
<tr class="separator:a65f4ba85d95c15ebc07377a2b74959da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12606bd15901a56b80e3a68b6078294d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemastodonpp.html#af8b3b89118adeccc71c54dfd36c987f6">parametermap</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a12606bd15901a56b80e3a68b6078294d">next</a> () const</td></tr>
<tr class="memdesc:a12606bd15901a56b80e3a68b6078294d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the parameters needed for the next entries. <a href="structmastodonpp_1_1answer__type.html#a12606bd15901a56b80e3a68b6078294d">More...</a><br /></td></tr>
<tr class="separator:a12606bd15901a56b80e3a68b6078294d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54baac6518a4178062d6963661ba50e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemastodonpp.html#af8b3b89118adeccc71c54dfd36c987f6">parametermap</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a54baac6518a4178062d6963661ba50e9">prev</a> () const</td></tr>
<tr class="memdesc:a54baac6518a4178062d6963661ba50e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the parameters needed for the previous entries. <a href="structmastodonpp_1_1answer__type.html#a54baac6518a4178062d6963661ba50e9">More...</a><br /></td></tr>
<tr class="separator:a54baac6518a4178062d6963661ba50e9"><td class="memSeparator" colspan="2">&#160;</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:a7c5582c4500034c0ea36ab1694944139"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a7c5582c4500034c0ea36ab1694944139">curl_error_code</a> {0}</td></tr>
<tr class="memdesc:a7c5582c4500034c0ea36ab1694944139"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error code returned by libcurl. <a href="structmastodonpp_1_1answer__type.html#a7c5582c4500034c0ea36ab1694944139">More...</a><br /></td></tr>
<tr class="separator:a7c5582c4500034c0ea36ab1694944139"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adda74145891e444f223ccdfe623af726"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#adda74145891e444f223ccdfe623af726">error_message</a></td></tr>
<tr class="memdesc:adda74145891e444f223ccdfe623af726"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error message. <a href="structmastodonpp_1_1answer__type.html#adda74145891e444f223ccdfe623af726">More...</a><br /></td></tr>
<tr class="separator:adda74145891e444f223ccdfe623af726"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0716af5033e02551937187a149c3f52d"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a0716af5033e02551937187a149c3f52d">http_status</a> {0}</td></tr>
<tr class="memdesc:a0716af5033e02551937187a149c3f52d"><td class="mdescLeft">&#160;</td><td class="mdescRight">HTTP status code. <a href="structmastodonpp_1_1answer__type.html#a0716af5033e02551937187a149c3f52d">More...</a><br /></td></tr>
<tr class="separator:a0716af5033e02551937187a149c3f52d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab84b7094800ffe32d34b33085dcef9aa"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a></td></tr>
<tr class="memdesc:ab84b7094800ffe32d34b33085dcef9aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The headers of the response from the server. <a href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">More...</a><br /></td></tr>
<tr class="separator:ab84b7094800ffe32d34b33085dcef9aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9da206eb4954ff15402083379909cc38"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38">body</a></td></tr>
<tr class="memdesc:a9da206eb4954ff15402083379909cc38"><td class="mdescLeft">&#160;</td><td class="mdescRight">The response from the server, usually JSON. <a href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38">More...</a><br /></td></tr>
<tr class="separator:a9da206eb4954ff15402083379909cc38"><td class="memSeparator" colspan="2">&#160;</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:a0154563855aee896209319101c217106"><td class="memItemLeft" align="right" valign="top">ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmastodonpp_1_1answer__type.html#a0154563855aee896209319101c217106">operator&lt;&lt;</a> (ostream &amp;out, const <a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> &amp;answer)</td></tr>
<tr class="memdesc:a0154563855aee896209319101c217106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <a class="el" href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38" title="The response from the server, usually JSON.">body</a> as <code>std::ostream</code>. <a href="structmastodonpp_1_1answer__type.html#a0154563855aee896209319101c217106">More...</a><br /></td></tr>
<tr class="separator:a0154563855aee896209319101c217106"><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>Return type for Requests. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a65f4ba85d95c15ebc07377a2b74959da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65f4ba85d95c15ebc07377a2b74959da">&#9670;&nbsp;</a></span>get_header()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string_view mastodonpp::answer_type::get_header </td>
<td>(</td>
<td class="paramtype">string_view&#160;</td>
<td class="paramname"><em>field</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value of a header field. </p>
<p>Is only valid for as long as the <a class="el" href="structmastodonpp_1_1answer__type.html" title="Return type for Requests.">answer_type</a> is in scope.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>Case insensitive, only ASCII.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;{</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> string_view searchstring{string(field) += <span class="charliteral">&#39;:&#39;</span>};</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// clang-format off</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">auto</span> it{search(<a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>.begin(), <a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>.end(), searchstring.begin(),</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; searchstring.end(), [](<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> a, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> b)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; { return tolower(a) == tolower(b); })};</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="comment">// clang-format on</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">if</span> (it != <a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>.end())</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">auto</span> pos{<span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(it - <a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>.begin())};</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; pos = <a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>.find(<span class="charliteral">&#39;:&#39;</span>, pos) + 2;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">const</span> <span class="keyword">auto</span> endpos{<a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>.find(<span class="charliteral">&#39;\n&#39;</span>, pos)};</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> string_view(&amp;<a class="code" href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">headers</a>[pos], endpos - pos);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">return</span> {};</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a12606bd15901a56b80e3a68b6078294d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12606bd15901a56b80e3a68b6078294d">&#9670;&nbsp;</a></span>next()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemastodonpp.html#af8b3b89118adeccc71c54dfd36c987f6">parametermap</a> mastodonpp::answer_type::next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the parameters needed for the next entries. </p>
<p>Parses the <code>Link</code> header.</p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; {</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordflow">return</span> parse_pagination(<span class="keyword">true</span>);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="aea7a4e100d215562a1d6b00524f99103"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7a4e100d215562a1d6b00524f99103">&#9670;&nbsp;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::answer_type::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if <a class="el" href="structmastodonpp_1_1answer__type.html#a7c5582c4500034c0ea36ab1694944139" title="The error code returned by libcurl.">curl_error_code</a> is 0 and <a class="el" href="structmastodonpp_1_1answer__type.html#a0716af5033e02551937187a149c3f52d" title="HTTP status code.">http_status</a> is 200, false otherwise. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><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="keywordflow">return</span> (<a class="code" href="structmastodonpp_1_1answer__type.html#a7c5582c4500034c0ea36ab1694944139">curl_error_code</a> == 0 &amp;&amp; <a class="code" href="structmastodonpp_1_1answer__type.html#a0716af5033e02551937187a149c3f52d">http_status</a> == 200);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a6c90b439bcf65b4a4a655e9213b14a0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c90b439bcf65b4a4a655e9213b14a0f">&#9670;&nbsp;</a></span>operator string_view()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mastodonpp::answer_type::operator string_view </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns <a class="el" href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38" title="The response from the server, usually JSON.">body</a> as <code>std::string_view</code>. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> <a class="code" href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38">body</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a54baac6518a4178062d6963661ba50e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54baac6518a4178062d6963661ba50e9">&#9670;&nbsp;</a></span>prev()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemastodonpp.html#af8b3b89118adeccc71c54dfd36c987f6">parametermap</a> mastodonpp::answer_type::prev </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the parameters needed for the previous entries. </p>
<p>Parses the <code>Link</code> header.</p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keywordflow">return</span> parse_pagination(<span class="keyword">false</span>);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a0154563855aee896209319101c217106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0154563855aee896209319101c217106">&#9670;&nbsp;</a></span>operator&lt;&lt;</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ostream&amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmastodonpp_1_1answer__type.html">answer_type</a> &amp;&#160;</td>
<td class="paramname"><em>answer</em>&#160;</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 <a class="el" href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38" title="The response from the server, usually JSON.">body</a> as <code>std::ostream</code>. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; out &lt;&lt; answer.body;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> out;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9da206eb4954ff15402083379909cc38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9da206eb4954ff15402083379909cc38">&#9670;&nbsp;</a></span>body</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string mastodonpp::answer_type::body</td>
</tr>
</table>
</div><div class="memdoc">
<p>The response from the server, usually JSON. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<a id="a7c5582c4500034c0ea36ab1694944139"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c5582c4500034c0ea36ab1694944139">&#9670;&nbsp;</a></span>curl_error_code</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t mastodonpp::answer_type::curl_error_code {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p>The error code returned by libcurl. </p>
<p>For more information consult <a href="https://curl.haxx.se/libcurl/c/libcurl-errors.html">libcurl-errors(3)</a>.</p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<a id="adda74145891e444f223ccdfe623af726"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adda74145891e444f223ccdfe623af726">&#9670;&nbsp;</a></span>error_message</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string mastodonpp::answer_type::error_message</td>
</tr>
</table>
</div><div class="memdoc">
<p>The error message. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<a id="ab84b7094800ffe32d34b33085dcef9aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab84b7094800ffe32d34b33085dcef9aa">&#9670;&nbsp;</a></span>headers</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string mastodonpp::answer_type::headers</td>
</tr>
</table>
</div><div class="memdoc">
<p>The headers of the response from the server. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<a id="a0716af5033e02551937187a149c3f52d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0716af5033e02551937187a149c3f52d">&#9670;&nbsp;</a></span>http_status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t mastodonpp::answer_type::http_status {0}</td>
</tr>
</table>
</div><div class="memdoc">
<p>HTTP status code. </p>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>include/<a class="el" href="types_8hpp_source.html">types.hpp</a></li>
<li>src/types.cpp</li>
</ul>
</div><!-- contents -->
<div class="ttc" id="astructmastodonpp_1_1answer__type_html_ab84b7094800ffe32d34b33085dcef9aa"><div class="ttname"><a href="structmastodonpp_1_1answer__type.html#ab84b7094800ffe32d34b33085dcef9aa">mastodonpp::answer_type::headers</a></div><div class="ttdeci">string headers</div><div class="ttdoc">The headers of the response from the server.</div><div class="ttdef"><b>Definition:</b> types.hpp:112</div></div>
<div class="ttc" id="astructmastodonpp_1_1answer__type_html_a7c5582c4500034c0ea36ab1694944139"><div class="ttname"><a href="structmastodonpp_1_1answer__type.html#a7c5582c4500034c0ea36ab1694944139">mastodonpp::answer_type::curl_error_code</a></div><div class="ttdeci">uint8_t curl_error_code</div><div class="ttdoc">The error code returned by libcurl.</div><div class="ttdef"><b>Definition:</b> types.hpp:91</div></div>
<div class="ttc" id="astructmastodonpp_1_1answer__type_html_a9da206eb4954ff15402083379909cc38"><div class="ttname"><a href="structmastodonpp_1_1answer__type.html#a9da206eb4954ff15402083379909cc38">mastodonpp::answer_type::body</a></div><div class="ttdeci">string body</div><div class="ttdoc">The response from the server, usually JSON.</div><div class="ttdef"><b>Definition:</b> types.hpp:119</div></div>
<div class="ttc" id="astructmastodonpp_1_1answer__type_html_a0716af5033e02551937187a149c3f52d"><div class="ttname"><a href="structmastodonpp_1_1answer__type.html#a0716af5033e02551937187a149c3f52d">mastodonpp::answer_type::http_status</a></div><div class="ttdeci">uint16_t http_status</div><div class="ttdoc">HTTP status code.</div><div class="ttdef"><b>Definition:</b> types.hpp:105</div></div>
<!-- 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.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink