ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4ba075f68950c370c589f57fd777b9a9b9f8bde8
rippled/temp__dir_8h_source.html
bthomee 4ba075f689 deploy: 2406b28e64
2025-03-11 18:21:06 +00:00

168 lines
19 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_31b47b71b675f5c4d1b67be42516b2a9.html">beast</a></li><li class="navelem"><a class="el" href="dir_252ea425b8516b0628e052e5ec460ff2.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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright 2013, Vinnie Falco &lt;vinnie.falco@gmail.com&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" 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 id="l00012" 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 id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" 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 id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef BEAST_UTILITY_TEMP_DIR_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define BEAST_UTILITY_TEMP_DIR_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;boost/filesystem.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacebeast.html">beast</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html"> 34</a></span><span class="keyword">class </span><a class="code hl_class" href="classbeast_1_1temp__dir.html">temp_dir</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>{</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6"> 36</a></span> boost::filesystem::path <a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#if !GENERATING_DOCS</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_function" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">temp_dir</a>(<span class="keyword">const</span> <a class="code hl_class" href="classbeast_1_1temp__dir.html">temp_dir</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="classbeast_1_1temp__dir.html">temp_dir</a>&amp;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> operator=(<span class="keyword">const</span> <a class="code hl_class" href="classbeast_1_1temp__dir.html">temp_dir</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58"> 46</a></span> <a class="code hl_function" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">temp_dir</a>()</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">auto</span> <span class="keyword">const</span> dir = boost::filesystem::temp_directory_path();</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">do</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a> = dir / boost::filesystem::unique_path();</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> } <span class="keywordflow">while</span> (boost::filesystem::exists(<a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>));</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> boost::filesystem::create_directory(<a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00"> 57</a></span> <a class="code hl_function" href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00">~temp_dir</a>()</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> {</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="comment">// use non-throwing calls in the destructor</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> boost::system::error_code ec;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> boost::filesystem::remove_all(<a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>, ec);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// TODO: warn/notify if ec set ?</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> }</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb"> 67</a></span> <a class="code hl_function" href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb">path</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a>.string();</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2"> 77</a></span> <a class="code hl_function" href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2">file</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; name)<span class="keyword"> const</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">return</span> (<a class="code hl_variable" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a> / name).<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/basic_string.html">string</a>();</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>};</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>} <span class="comment">// namespace beast</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="preprocessor">#endif</span></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>
<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#l00034">temp_dir.h:35</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#l00067">temp_dir.h:67</a></div></div>
<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#l00036">temp_dir.h:36</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#l00046">temp_dir.h:46</a></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#l00057">temp_dir.h:57</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 &amp;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#l00077">temp_dir.h:77</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#l00662">base_uint.h:662</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>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink