<!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>libfilezilla: buffer.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="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="projectlogo"><img alt="Logo" src="libfilezilla.png"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libfilezilla </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_bfd4f94fea6b65a4615f91ddf59adbf8.html">libfilezilla</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">buffer.hpp</div> </div> </div><!--header--> <div class="contents"> <a href="buffer_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef LIBFILEZILLA_BUFFER_HEADER</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIBFILEZILLA_BUFFER_HEADER</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="libfilezilla_8hpp.html">libfilezilla.hpp</a>"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespacefz.html">fz</a> {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classfz_1_1buffer.html"> 23</a></span> <span class="keyword">class </span>FZ_PUBLIC_SYMBOL <a class="code" href="classfz_1_1buffer.html">buffer</a> final</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="classfz_1_1buffer.html">buffer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">explicit</span> <a class="code" href="classfz_1_1buffer.html">buffer</a>(<span class="keywordtype">size_t</span> capacity);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classfz_1_1buffer.html">buffer</a>(<a class="code" href="classfz_1_1buffer.html">buffer</a> <span class="keyword">const</span>& buf);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classfz_1_1buffer.html">buffer</a>(<a class="code" href="classfz_1_1buffer.html">buffer</a> && buf) noexcept;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  ~<a class="code" href="classfz_1_1buffer.html">buffer</a>() { <span class="keyword">delete</span>[] data_; }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classfz_1_1buffer.html">buffer</a>& operator=(<a class="code" href="classfz_1_1buffer.html">buffer</a> <span class="keyword">const</span>& buf);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classfz_1_1buffer.html">buffer</a>& operator=(<a class="code" href="classfz_1_1buffer.html">buffer</a> && buf) noexcept;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classfz_1_1buffer.html#a8d08d9ed83b2dd2b0658167224d6d778"> 40</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* <a class="code" href="classfz_1_1buffer.html#a8d08d9ed83b2dd2b0658167224d6d778">get</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pos_; }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* get() { <span class="keywordflow">return</span> pos_; }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* get(<span class="keywordtype">size_t</span> write_size);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> add(<span class="keywordtype">size_t</span> added);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">void</span> consume(<span class="keywordtype">size_t</span> consumed);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">size_t</span> size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> size_; }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> clear();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> append(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* data, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> append(std::string_view <span class="keyword">const</span>& str);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">bool</span> empty()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> size_ == 0; }</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">explicit</span> <span class="keyword">operator</span> bool()<span class="keyword"> const </span>{</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> size_ != 0;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> reserve(<span class="keywordtype">size_t</span> capacity);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> resize(<span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classfz_1_1buffer.html#ad2eddc262b004b87689944f3228219b9"> 96</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="classfz_1_1buffer.html#ad2eddc262b004b87689944f3228219b9">operator[]</a>(<span class="keywordtype">size_t</span> i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> pos_[i]; }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> & operator[](<span class="keywordtype">size_t</span> i) { <span class="keywordflow">return</span> pos_[i]; }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">bool</span> operator==(buffer <span class="keyword">const</span>& rhs) <span class="keyword">const</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">bool</span> operator!=(buffer <span class="keyword">const</span>& rhs)<span class="keyword"> const </span>{</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == rhs);</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="comment">// Invariants:</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="comment">// size_ <= capacity_</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// data_ <= pos_</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">// pos_ <= data_ + capacity_</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// pos_ + size_ <= data_ + capacity_</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* data_{};</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* pos_{};</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">size_t</span> size_{};</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordtype">size_t</span> capacity_{};</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> };</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="namespacefz_html"><div class="ttname"><a href="namespacefz.html">fz</a></div><div class="ttdoc">The namespace used by libfilezilla.</div><div class="ttdef"><b>Definition:</b> apply.hpp:17</div></div> <div class="ttc" id="libfilezilla_8hpp_html"><div class="ttname"><a href="libfilezilla_8hpp.html">libfilezilla.hpp</a></div><div class="ttdoc">Sets some global macros and further includes string.hpp.</div></div> <div class="ttc" id="classfz_1_1buffer_html"><div class="ttname"><a href="classfz_1_1buffer.html">fz::buffer</a></div><div class="ttdoc">The buffer class is a simple buffer where data can be appended at the end and consumed at the front....</div><div class="ttdef"><b>Definition:</b> buffer.hpp:23</div></div> <div class="ttc" id="classfz_1_1buffer_html_a8d08d9ed83b2dd2b0658167224d6d778"><div class="ttname"><a href="classfz_1_1buffer.html#a8d08d9ed83b2dd2b0658167224d6d778">fz::buffer::get</a></div><div class="ttdeci">unsigned char const * get() const</div><div class="ttdoc">Undefined if buffer is empty.</div><div class="ttdef"><b>Definition:</b> buffer.hpp:40</div></div> <div class="ttc" id="classfz_1_1buffer_html_ad2eddc262b004b87689944f3228219b9"><div class="ttname"><a href="classfz_1_1buffer.html#ad2eddc262b004b87689944f3228219b9">fz::buffer::operator[]</a></div><div class="ttdeci">unsigned char operator[](size_t i) const</div><div class="ttdoc">Gets element at offset i. Does not do bounds checking.</div><div class="ttdef"><b>Definition:</b> buffer.hpp:96</div></div> </div><!-- fragment --></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>