1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
<!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>LLFIO: llfio_v2_xxx::algorithm::summarize_visitor Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">LLFIO
 <span id="projectnumber">v2.00 late beta</span>
</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">llfio_v2_xxx::algorithm::summarize_visitor Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A visitor for the filesystem traversal and summary algorithm.
<a href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html#details">More...</a></p>
<p><code>#include "summarize.hpp"</code></p>
<div class="dynheader">
Inheritance diagram for llfio_v2_xxx::algorithm::summarize_visitor:</div>
<div class="dyncontent">
<div class="center">
<img src="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.png" usemap="#llfio_5Fv2_5Fxxx::algorithm::summarize_5Fvisitor_map" alt=""/>
<map id="llfio_5Fv2_5Fxxx::algorithm::summarize_5Fvisitor_map" name="llfio_5Fv2_5Fxxx::algorithm::summarize_5Fvisitor_map">
<area href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html" title="A visitor for the filesystem traversal algorithm." alt="llfio_v2_xxx::algorithm::traverse_visitor" shape="rect" coords="0,0,241,24"/>
</map>
</div></div>
<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:a2d6b2c113d9c3fad2318e9d0e5f83c13"><td class="memItemLeft" align="right" valign="top"><a id="a2d6b2c113d9c3fad2318e9d0e5f83c13"></a>
virtual result< <a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html#a2d6b2c113d9c3fad2318e9d0e5f83c13">directory_open_failed</a> (void *data, result< void >::error_type &&<a class="el" href="classllfio__v2__xxx_1_1error.html">error</a>, const <a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a> &dirh, <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> leaf, size_t depth) noexcept override</td></tr>
<tr class="memdesc:a2d6b2c113d9c3fad2318e9d0e5f83c13"><td class="mdescLeft"> </td><td class="mdescRight">This override ignores failures to traverse into the directory. <br /></td></tr>
<tr class="separator:a2d6b2c113d9c3fad2318e9d0e5f83c13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35fefdd810e1ce57734832a22916ca05"><td class="memItemLeft" align="right" valign="top"><a id="a35fefdd810e1ce57734832a22916ca05"></a>
virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html#a35fefdd810e1ce57734832a22916ca05">post_enumeration</a> (void *data, const <a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a> &dirh, <a class="el" href="structllfio__v2__xxx_1_1directory__handle_1_1buffers__type.html">directory_handle::buffers_type</a> &<a class="el" href="namespacellfio__v2__xxx_1_1algorithm.html#afae251fc3bfb7280b47b6135e2f6c7e2">contents</a>, size_t depth) noexcept override</td></tr>
<tr class="memdesc:a35fefdd810e1ce57734832a22916ca05"><td class="mdescLeft"> </td><td class="mdescRight">This override implements the summary. <br /></td></tr>
<tr class="separator:a35fefdd810e1ce57734832a22916ca05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d3c4b226532089d121dc3d96ed88b39"><td class="memItemLeft" align="right" valign="top">virtual result< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#a4d3c4b226532089d121dc3d96ed88b39">pre_enumeration</a> (void *data, const <a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a> &dirh, size_t depth) noexcept</td></tr>
<tr class="memdesc:a4d3c4b226532089d121dc3d96ed88b39"><td class="mdescLeft"> </td><td class="mdescRight">Called to decide whether to enumerate a directory. <a href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#a4d3c4b226532089d121dc3d96ed88b39">More...</a><br /></td></tr>
<tr class="separator:a4d3c4b226532089d121dc3d96ed88b39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44e3a5ace0aa50d8f6f836c48e510c54"><td class="memItemLeft" align="right" valign="top">virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#a44e3a5ace0aa50d8f6f836c48e510c54">stack_updated</a> (void *data, size_t dirs_processed, size_t known_dirs_remaining, size_t depth_processed, size_t known_depth_remaining) noexcept</td></tr>
<tr class="memdesc:a44e3a5ace0aa50d8f6f836c48e510c54"><td class="mdescLeft"> </td><td class="mdescRight">Called whenever the traversed stack of directory hierarchy is updated. This can act as an estimated progress indicator, or to give an accurate progress indicator by matching it against a previous traversal. \data The third party data pointer passed to <code>traverse()</code>. <a href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#a44e3a5ace0aa50d8f6f836c48e510c54">More...</a><br /></td></tr>
<tr class="separator:a44e3a5ace0aa50d8f6f836c48e510c54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac188f8691259ec970aeff79b47a5685b"><td class="memItemLeft" align="right" valign="top"><a id="ac188f8691259ec970aeff79b47a5685b"></a>
virtual result< size_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#ac188f8691259ec970aeff79b47a5685b">finished</a> (void *data, result< size_t > result) noexcept</td></tr>
<tr class="memdesc:ac188f8691259ec970aeff79b47a5685b"><td class="mdescLeft"> </td><td class="mdescRight">Called when a traversal finishes, whether due to success or failure. Always called from the original thread. <br /></td></tr>
<tr class="separator:ac188f8691259ec970aeff79b47a5685b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae809b157a45e28f55e678c13ab298ff9"><td class="memItemLeft" align="right" valign="top"><a id="ae809b157a45e28f55e678c13ab298ff9"></a>
static result< void > </td><td class="memItemRight" valign="bottom"><b>accumulate</b> (<a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1traversal__summary.html">traversal_summary</a> &acc, <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1traversal__summary.html">traversal_summary</a> *state, const <a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a> *dirh, <a class="el" href="structllfio__v2__xxx_1_1directory__entry.html">directory_entry</a> &entry, stat_t::want already_have_metadata)</td></tr>
<tr class="separator:ae809b157a45e28f55e678c13ab298ff9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A visitor for the filesystem traversal and summary algorithm. </p>
<p>Note that at any time, returning a failure causes <code>summarize()</code> to exit as soon as possible with the same failure.</p>
<p>You can override the members here inherited from <code>traverse_visitor</code>, however note that <code>summarize()</code> is entirely implemented using <code>traverse()</code>, so not calling the implementations here will affect operation. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4d3c4b226532089d121dc3d96ed88b39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d3c4b226532089d121dc3d96ed88b39">◆ </a></span>pre_enumeration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result<bool> llfio_v2_xxx::algorithm::traverse_visitor::pre_enumeration </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a> & </td>
<td class="paramname"><em>dirh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>depth</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to decide whether to enumerate a directory. </p>
<p>Note that it is more efficient to ignore the directory entry in <code>post_enumeration()</code> than to ignore it here, as a handle is opened for the directory before this callback. Equally, if you need that handle to inspect the directory e.g. to check if one is entering a different filesystem from the root, here is best.</p>
<p>The default returns <code>true</code>.</p>
<dl class="section note"><dt>Note</dt><dd>May be called from multiple kernel threads concurrently. </dd></dl>
<div class="fragment"><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  (void) data;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  (void) dirh;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  (void) depth;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a44e3a5ace0aa50d8f6f836c48e510c54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44e3a5ace0aa50d8f6f836c48e510c54">◆ </a></span>stack_updated()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual result<void> llfio_v2_xxx::algorithm::traverse_visitor::stack_updated </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>dirs_processed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>known_dirs_remaining</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>depth_processed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>known_depth_remaining</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span><span class="mlabel">noexcept</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called whenever the traversed stack of directory hierarchy is updated. This can act as an estimated progress indicator, or to give an accurate progress indicator by matching it against a previous traversal. \data The third party data pointer passed to <code>traverse()</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dirs_processed</td><td>The total number of directories traversed so far. </td></tr>
<tr><td class="paramname">known_dirs_remaining</td><td>The currently known number of directories awaiting traversal. </td></tr>
<tr><td class="paramname">depth_processed</td><td>How many levels deep we have already completely traversed. </td></tr>
<tr><td class="paramname">known_depth_remaining</td><td>The currently known number of levels we shall traverse.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>May be called from multiple kernel threads concurrently. </dd></dl>
<div class="fragment"><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  (void) data;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  (void) dirs_processed;</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  (void) known_dirs_remaining;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  (void) depth_processed;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  (void) known_depth_remaining;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">return</span> success();</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/llfio/v2.0/algorithm/<a class="el" href="summarize_8hpp.html">summarize.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacellfio__v2__xxx.html">llfio_v2_xxx</a></li><li class="navelem"><a class="el" href="namespacellfio__v2__xxx_1_1algorithm.html">algorithm</a></li><li class="navelem"><a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html">summarize_visitor</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>
|
