mirror of
https://github.com/minio/minio-cpp.git
synced 2025-08-02 03:46:35 +03:00
207 lines
21 KiB
HTML
207 lines
21 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>MinIO C++ SDK: /home/bala/devel/github.com/minio/minio-cpp/include/types.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.9.1 -->
|
|
<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','.html');
|
|
/* @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_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">types.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <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> <span class="comment">// Copyright 2022 MinIO, Inc.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <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> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <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> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <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> <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> <span class="comment">// limitations under the License.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifndef _MINIO_S3_TYPES_H</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define _MINIO_S3_TYPES_H</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <iostream></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "utils.h"</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>minio {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>s3 {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">enum class</span> RetentionMode { kGovernance, kCompliance };</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// StringToRetentionMode converts string to retention mode enum.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> RetentionMode StringToRetentionMode(std::string_view str) <span class="keywordflow">throw</span>();</div>
|
|
<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> constexpr <span class="keywordtype">bool</span> IsRetentionModeValid(RetentionMode& retention) {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">switch</span> (retention) {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">case</span> RetentionMode::kGovernance:</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">case</span> RetentionMode::kCompliance:</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</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>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> }</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// RetentionModeToString converts retention mode enum to string.</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> constexpr <span class="keyword">const</span> <span class="keywordtype">char</span>* RetentionModeToString(RetentionMode& retention) <span class="keywordflow">throw</span>() {</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">switch</span> (retention) {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">case</span> RetentionMode::kGovernance:</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <span class="stringliteral">"GOVERNANCE"</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordflow">case</span> RetentionMode::kCompliance:</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> <span class="stringliteral">"COMPLIANCE"</span>;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">default</span>: {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::cerr << <span class="stringliteral">"ABORT: Unknown retention mode. This should not happen."</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  << std::endl;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  std::terminate();</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  }</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> NULL;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">enum class</span> LegalHold { kOn, kOff };</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// StringToLegalHold converts string to legal hold enum.</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> LegalHold StringToLegalHold(std::string_view str) <span class="keywordflow">throw</span>();</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> constexpr <span class="keywordtype">bool</span> IsLegalHoldValid(LegalHold& legal_hold) {</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">switch</span> (legal_hold) {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">case</span> LegalHold::kOn:</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">case</span> LegalHold::kOff:</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> }</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// LegalHoldToString converts legal hold enum to string.</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> constexpr <span class="keyword">const</span> <span class="keywordtype">char</span>* LegalHoldToString(LegalHold& legal_hold) <span class="keywordflow">throw</span>() {</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">switch</span> (legal_hold) {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">case</span> LegalHold::kOn:</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">return</span> <span class="stringliteral">"ON"</span>;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">case</span> LegalHold::kOff:</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> <span class="stringliteral">"OFF"</span>;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">default</span>: {</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::cerr << <span class="stringliteral">"ABORT: Unknown legal hold. This should not happen."</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  << std::endl;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::terminate();</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> NULL;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> }</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">enum class</span> Directive { kCopy, kReplace };</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// StringToDirective converts string to directive enum.</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> Directive StringToDirective(std::string_view str) <span class="keywordflow">throw</span>();</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> <span class="comment">// DirectiveToString converts directive enum to string.</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> constexpr <span class="keyword">const</span> <span class="keywordtype">char</span>* DirectiveToString(Directive& directive) <span class="keywordflow">throw</span>() {</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">switch</span> (directive) {</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordflow">case</span> Directive::kCopy:</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">return</span> <span class="stringliteral">"COPY"</span>;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">case</span> Directive::kReplace:</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> <span class="stringliteral">"REPLACE"</span>;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">default</span>: {</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  std::cerr << <span class="stringliteral">"ABORT: Unknown directive. This should not happen."</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  << std::endl;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  std::terminate();</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  }</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> NULL;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</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"><a class="line" href="structminio_1_1s3_1_1Bucket.html"> 106</a></span> <span class="keyword">struct </span><a class="code" href="structminio_1_1s3_1_1Bucket.html">Bucket</a> {</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  std::string name;</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classminio_1_1utils_1_1Time.html">utils::Time</a> creation_date;</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> }; <span class="comment">// struct Bucket</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="structminio_1_1s3_1_1Part.html"> 111</a></span> <span class="keyword">struct </span><a class="code" href="structminio_1_1s3_1_1Part.html">Part</a> {</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> number;</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  std::string etag;</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classminio_1_1utils_1_1Time.html">utils::Time</a> last_modified;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">size_t</span> size;</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> }; <span class="comment">// struct Part</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"><a class="line" href="structminio_1_1s3_1_1Retention.html"> 118</a></span> <span class="keyword">struct </span><a class="code" href="structminio_1_1s3_1_1Retention.html">Retention</a> {</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  RetentionMode mode;</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="classminio_1_1utils_1_1Time.html">utils::Time</a> retain_until_date;</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> }; <span class="comment">// struct Retention</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">// namespace s3</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> } <span class="comment">// namespace minio</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif </span><span class="comment">// #ifndef __MINIO_S3_TYPES_H</span></div>
|
|
<div class="ttc" id="aclassminio_1_1utils_1_1Time_html"><div class="ttname"><a href="classminio_1_1utils_1_1Time.html">minio::utils::Time</a></div><div class="ttdef"><b>Definition:</b> utils.h:97</div></div>
|
|
<div class="ttc" id="astructminio_1_1s3_1_1Bucket_html"><div class="ttname"><a href="structminio_1_1s3_1_1Bucket.html">minio::s3::Bucket</a></div><div class="ttdef"><b>Definition:</b> types.h:106</div></div>
|
|
<div class="ttc" id="astructminio_1_1s3_1_1Part_html"><div class="ttname"><a href="structminio_1_1s3_1_1Part.html">minio::s3::Part</a></div><div class="ttdef"><b>Definition:</b> types.h:111</div></div>
|
|
<div class="ttc" id="astructminio_1_1s3_1_1Retention_html"><div class="ttname"><a href="structminio_1_1s3_1_1Retention.html">minio::s3::Retention</a></div><div class="ttdef"><b>Definition:</b> types.h:118</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|