1
0
mirror of https://github.com/minio/minio-cpp.git synced 2025-08-12 09:42:44 +03:00
Files
minio-cpp/docs/html/s3__headers_8h_source.html
Harshavardhana 18362643df add doxygen docs
2021-10-20 21:07:30 -07:00

215 lines
23 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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MinIO C++ SDK: /home/harsha/mygo/src/github.com/minio/minio-cpp/include/s3_headers.h 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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MinIO C++ SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">s3_headers.h</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">// MinIO C++ Library for Amazon S3 Compatible Cloud Storage</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright 2021 MinIO, Inc.</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">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// You may obtain a copy of the License at</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">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;cstdlib&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;exception&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;stdexcept&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;s3_http.h&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structDictionary__Error.html"> 27</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structDictionary__Error.html">Dictionary_Error</a>: <span class="keyword">public</span> std::runtime_error {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="structDictionary__Error.html">Dictionary_Error</a>(<span class="keyword">const</span> std::string &amp; msg = <span class="stringliteral">&quot;&quot;</span>): std::runtime_error(msg) {}</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; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span>Minio</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// A simple string-to-string dictionary, with additional methods for conversion to doubles and integers.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classMinio_1_1Headers.html"> 34</a></span>&#160; <span class="keyword">class </span><a class="code" href="classMinio_1_1Headers.html">Headers</a> {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; Minio::Http::HeaderValueCollection entries;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classMinio_1_1Headers.html">Headers</a>() {}</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">typedef</span> Minio::Http::HeaderValueCollection::iterator iterator;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">typedef</span> Minio::Http::HeaderValueCollection::const_iterator const_iterator;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; iterator begin() {<span class="keywordflow">return</span> entries.begin();}</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; const_iterator begin()<span class="keyword"> const </span>{<span class="keywordflow">return</span> entries.begin();}</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; iterator end() {<span class="keywordflow">return</span> entries.end();}</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; const_iterator end()<span class="keyword"> const </span>{<span class="keywordflow">return</span> entries.end();}</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; std::pair&lt;iterator, iterator&gt; equal_range(<span class="keyword">const</span> std::string &amp; key) {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> entries.equal_range(key);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; std::pair&lt;const_iterator, const_iterator&gt; equal_range(<span class="keyword">const</span> std::string &amp; key)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span> entries.equal_range(key);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</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="keywordtype">void</span> Clear() {entries.clear();}</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="keywordtype">bool</span> Exists(<span class="keyword">const</span> std::string &amp; key)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (entries.find(key) != entries.end());}</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// Get first value for key if one exists. Return true if a value found for key,</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// return false otherwise.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp; key, std::string &amp; value)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">if</span>(val != entries.end()) value = val-&gt;second;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> (val != entries.end());</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">double</span> &amp; value)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">if</span>(val != entries.end()) value = strtod(val-&gt;second.c_str(), NULL);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> (val != entries.end());</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">int</span> &amp; value)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">if</span>(val != entries.end()) value = strtol(val-&gt;second.c_str(), NULL, 0);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> (val != entries.end());</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">long</span> &amp; value)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">if</span>(val != entries.end()) value = strtol(val-&gt;second.c_str(), NULL, 0);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> (val != entries.end());</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; }</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">bool</span> Get(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">size_t</span> &amp; value)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">if</span>(val != entries.end()) value = strtol(val-&gt;second.c_str(), NULL, 0);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> (val != entries.end());</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// Get first value for key if one exists. Return value if found for key,</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="comment">// return defaultVal otherwise.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">const</span> std::string &amp; GetWithDefault(<span class="keyword">const</span> std::string &amp; key, <span class="keyword">const</span> std::string &amp; defaultVal)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">return</span> (val != entries.end())? val-&gt;second : defaultVal;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; }</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">double</span> GetWithDefault(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">double</span> defaultVal)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">return</span> (val != entries.end())? strtod(val-&gt;second.c_str(), NULL) : defaultVal;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</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; <span class="keywordtype">int</span> GetWithDefault(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">int</span> defaultVal)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">return</span> (val != entries.end())? strtol(val-&gt;second.c_str(), NULL, 0) : defaultVal;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; }</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordtype">long</span> GetWithDefault(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">long</span> defaultVal)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">return</span> (val != entries.end())? strtol(val-&gt;second.c_str(), NULL, 0) : defaultVal;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keywordtype">size_t</span> GetWithDefault(<span class="keyword">const</span> std::string &amp; key, <span class="keywordtype">size_t</span> defaultVal)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; const_iterator val = entries.find(key);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">return</span> (val != entries.end())? strtol(val-&gt;second.c_str(), NULL, 0) : defaultVal;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// Insert entry into dictionary, overwrites existing key values.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordtype">void</span> Insert(<span class="keyword">const</span> std::string &amp; key, <span class="keyword">const</span> std::string &amp; value) {</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; entries.insert(std::make_pair(key, value));</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="comment">// Update value for existing key if possible, insert entry into dictionary if no value for key</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keywordtype">void</span> Update(<span class="keyword">const</span> std::string &amp; key, <span class="keyword">const</span> std::string &amp; value) {</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; iterator val = entries.find(key);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">if</span>(val == entries.end())</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; Insert(key, value);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; val-&gt;second = value;</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><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructDictionary__Error_html"><div class="ttname"><a href="structDictionary__Error.html">Dictionary_Error</a></div><div class="ttdef"><b>Definition:</b> s3_headers.h:27</div></div>
<div class="ttc" id="aclassMinio_1_1Headers_html"><div class="ttname"><a href="classMinio_1_1Headers.html">Minio::Headers</a></div><div class="ttdef"><b>Definition:</b> s3_headers.h:34</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.18
</small></address>
</body>
</html>