mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 03:26:01 +00:00
162 lines
18 KiB
HTML
162 lines
18 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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: temp_dir.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">rippled
|
|
</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&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_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_875063d0bf0fe9cb23dcbe977d2f1b80.html">beast</a></li><li class="navelem"><a class="el" href="dir_2b67fd6875b17637f054e6dcff6dfba3.html">utility</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">temp_dir.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">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of Beast: https://github.com/vinniefalco/Beast</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com></span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</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"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef BEAST_UTILITY_TEMP_DIR_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define BEAST_UTILITY_TEMP_DIR_H_INCLUDED</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="preprocessor">#include <boost/filesystem.hpp></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespacebeast.html">beast</a> {</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html"> 33</a></span> <span class="keyword">class </span><a class="code" href="classbeast_1_1temp__dir.html">temp_dir</a></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> {</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6"> 35</a></span>  boost::filesystem::path <a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#if !GENERATING_DOCS</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">temp_dir</a>(<span class="keyword">const</span> <a class="code" href="classbeast_1_1temp__dir.html">temp_dir</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classbeast_1_1temp__dir.html">temp_dir</a>&</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  operator=(<span class="keyword">const</span> <a class="code" href="classbeast_1_1temp__dir.html">temp_dir</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58"> 45</a></span>  <a class="code" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">temp_dir</a>()</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">auto</span> <span class="keyword">const</span> dir = boost::filesystem::temp_directory_path();</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">do</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a> = dir / boost::filesystem::unique_path();</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  } <span class="keywordflow">while</span> (boost::filesystem::exists(<a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>));</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  boost::filesystem::create_directory(<a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>);</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="l00056"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00"> 56</a></span>  <a class="code" href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00">~temp_dir</a>()</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// use non-throwing calls in the destructor</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  boost::system::error_code ec;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  boost::filesystem::remove_all(<a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>, ec);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// TODO: warn/notify if ec set ?</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb"> 66</a></span>  <a class="code" href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb">path</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">return</span> <a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>.string();</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2"> 76</a></span>  <a class="code" href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2">file</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& name)<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> (<a class="code" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a> / name).<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string/basic_string.html">string</a>();</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</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="comment">// namespace beast</span></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> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassbeast_1_1temp__dir_html_a8c642e26d0f2d9ad67c7efdcadafd3c6"><div class="ttname"><a href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">beast::temp_dir::path_</a></div><div class="ttdeci">boost::filesystem::path path_</div><div class="ttdef"><b>Definition:</b> <a href="temp__dir_8h_source.html#l00035">temp_dir.h:35</a></div></div>
|
|
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="aclassbeast_1_1temp__dir_html_a9b65f2e7b6ef74d8ed5e9d402436fa00"><div class="ttname"><a href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00">beast::temp_dir::~temp_dir</a></div><div class="ttdeci">~temp_dir()</div><div class="ttdoc">Destroy a temporary directory.</div><div class="ttdef"><b>Definition:</b> <a href="temp__dir_8h_source.html#l00056">temp_dir.h:56</a></div></div>
|
|
<div class="ttc" id="aclassbeast_1_1temp__dir_html_a12a24007c243e0739cfc36703a3257bb"><div class="ttname"><a href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb">beast::temp_dir::path</a></div><div class="ttdeci">std::string path() const</div><div class="ttdoc">Get the native path for the temporary directory.</div><div class="ttdef"><b>Definition:</b> <a href="temp__dir_8h_source.html#l00066">temp_dir.h:66</a></div></div>
|
|
<div class="ttc" id="aclassbeast_1_1temp__dir_html_a92e785adc6ab26541254db724e4a7d58"><div class="ttname"><a href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">beast::temp_dir::temp_dir</a></div><div class="ttdeci">temp_dir()</div><div class="ttdoc">Construct a temporary directory.</div><div class="ttdef"><b>Definition:</b> <a href="temp__dir_8h_source.html#l00045">temp_dir.h:45</a></div></div>
|
|
<div class="ttc" id="aclassbeast_1_1temp__dir_html_acee939ad91b9f6bb2be31084ec04acc2"><div class="ttname"><a href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2">beast::temp_dir::file</a></div><div class="ttdeci">std::string file(std::string const &name) const</div><div class="ttdoc">Get the native path for the a file.</div><div class="ttdef"><b>Definition:</b> <a href="temp__dir_8h_source.html#l00076">temp_dir.h:76</a></div></div>
|
|
<div class="ttc" id="aclassbeast_1_1temp__dir_html"><div class="ttname"><a href="classbeast_1_1temp__dir.html">beast::temp_dir</a></div><div class="ttdoc">RAII temporary directory.</div><div class="ttdef"><b>Definition:</b> <a href="temp__dir_8h_source.html#l00033">temp_dir.h:33</a></div></div>
|
|
<div class="ttc" id="anamespacebeast_html"><div class="ttname"><a href="namespacebeast.html">beast</a></div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00585">base_uint.h:585</a></div></div>
|
|
<div class="ttc" id="astring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string.html">string</a></div></div>
|
|
<!-- 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.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|