mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
227 lines
11 KiB
HTML
227 lines
11 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: beast::temp_dir Class Reference</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="namespacebeast.html">beast</a></li><li class="navelem"><a class="el" href="classbeast_1_1temp__dir.html">temp_dir</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classbeast_1_1temp__dir-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">beast::temp_dir Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>RAII temporary directory.
|
|
<a href="classbeast_1_1temp__dir.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a92e785adc6ab26541254db724e4a7d58"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">temp_dir</a> ()</td></tr>
|
|
<tr class="memdesc:a92e785adc6ab26541254db724e4a7d58"><td class="mdescLeft"> </td><td class="mdescRight">Construct a temporary directory. <a href="classbeast_1_1temp__dir.html#a92e785adc6ab26541254db724e4a7d58">More...</a><br /></td></tr>
|
|
<tr class="separator:a92e785adc6ab26541254db724e4a7d58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b65f2e7b6ef74d8ed5e9d402436fa00"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00">~temp_dir</a> ()</td></tr>
|
|
<tr class="memdesc:a9b65f2e7b6ef74d8ed5e9d402436fa00"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a temporary directory. <a href="classbeast_1_1temp__dir.html#a9b65f2e7b6ef74d8ed5e9d402436fa00">More...</a><br /></td></tr>
|
|
<tr class="separator:a9b65f2e7b6ef74d8ed5e9d402436fa00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12a24007c243e0739cfc36703a3257bb"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb">path</a> () const</td></tr>
|
|
<tr class="memdesc:a12a24007c243e0739cfc36703a3257bb"><td class="mdescLeft"> </td><td class="mdescRight">Get the native path for the temporary directory. <a href="classbeast_1_1temp__dir.html#a12a24007c243e0739cfc36703a3257bb">More...</a><br /></td></tr>
|
|
<tr class="separator:a12a24007c243e0739cfc36703a3257bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acee939ad91b9f6bb2be31084ec04acc2"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2">file</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &name) const</td></tr>
|
|
<tr class="memdesc:acee939ad91b9f6bb2be31084ec04acc2"><td class="mdescLeft"> </td><td class="mdescRight">Get the native path for the a file. <a href="classbeast_1_1temp__dir.html#acee939ad91b9f6bb2be31084ec04acc2">More...</a><br /></td></tr>
|
|
<tr class="separator:acee939ad91b9f6bb2be31084ec04acc2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a8c642e26d0f2d9ad67c7efdcadafd3c6"><td class="memItemLeft" align="right" valign="top">boost::filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1temp__dir.html#a8c642e26d0f2d9ad67c7efdcadafd3c6">path_</a></td></tr>
|
|
<tr class="separator:a8c642e26d0f2d9ad67c7efdcadafd3c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>RAII temporary directory. </p>
|
|
<p>The directory and all its contents are deleted when the instance of <code><a class="el" href="classbeast_1_1temp__dir.html" title="RAII temporary directory.">temp_dir</a></code> is destroyed. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="temp__dir_8h_source.html#l00033">33</a> of file <a class="el" href="temp__dir_8h_source.html">temp_dir.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a92e785adc6ab26541254db724e4a7d58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92e785adc6ab26541254db724e4a7d58">◆ </a></span>temp_dir()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">beast::temp_dir::temp_dir </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a temporary directory. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="temp__dir_8h_source.html#l00045">45</a> of file <a class="el" href="temp__dir_8h_source.html">temp_dir.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b65f2e7b6ef74d8ed5e9d402436fa00"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b65f2e7b6ef74d8ed5e9d402436fa00">◆ </a></span>~temp_dir()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">beast::temp_dir::~temp_dir </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroy a temporary directory. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="temp__dir_8h_source.html#l00056">56</a> of file <a class="el" href="temp__dir_8h_source.html">temp_dir.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a12a24007c243e0739cfc36703a3257bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12a24007c243e0739cfc36703a3257bb">◆ </a></span>path()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> beast::temp_dir::path </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the native path for the temporary directory. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="temp__dir_8h_source.html#l00066">66</a> of file <a class="el" href="temp__dir_8h_source.html">temp_dir.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acee939ad91b9f6bb2be31084ec04acc2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acee939ad91b9f6bb2be31084ec04acc2">◆ </a></span>file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> beast::temp_dir::file </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the native path for the a file. </p>
|
|
<p>The file does not need to exist. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="temp__dir_8h_source.html#l00076">76</a> of file <a class="el" href="temp__dir_8h_source.html">temp_dir.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a8c642e26d0f2d9ad67c7efdcadafd3c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c642e26d0f2d9ad67c7efdcadafd3c6">◆ </a></span>path_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boost::filesystem::path beast::temp_dir::path_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="temp__dir_8h_source.html#l00035">35</a> of file <a class="el" href="temp__dir_8h_source.html">temp_dir.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|