diff options
Diffstat (limited to 'structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html')
| -rw-r--r-- | structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html | 402 |
1 files changed, 402 insertions, 0 deletions
diff --git a/structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html b/structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html new file mode 100644 index 00000000..4000cd30 --- /dev/null +++ b/structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html @@ -0,0 +1,402 @@ +<!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::traverse_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_1traverse__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="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">llfio_v2_xxx::algorithm::traverse_visitor Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A visitor for the filesystem traversal algorithm. + <a href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#details">More...</a></p> + +<p><code>#include "traverse.hpp"</code></p> +<div class="dynheader"> +Inheritance diagram for llfio_v2_xxx::algorithm::traverse_visitor:</div> +<div class="dyncontent"> + <div class="center"> + <img src="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.png" usemap="#llfio_5Fv2_5Fxxx::algorithm::traverse_5Fvisitor_map" alt=""/> + <map id="llfio_5Fv2_5Fxxx::algorithm::traverse_5Fvisitor_map" name="llfio_5Fv2_5Fxxx::algorithm::traverse_5Fvisitor_map"> +<area href="structllfio__v2__xxx_1_1algorithm_1_1compare__visitor.html" title="A visitor for the filesystem traversal and comparison algorithm." alt="llfio_v2_xxx::algorithm::compare_visitor" shape="rect" coords="0,56,241,80"/> +<area href="structllfio__v2__xxx_1_1algorithm_1_1contents__visitor.html" title="A visitor for the filesystem contents algorithm." alt="llfio_v2_xxx::algorithm::contents_visitor" shape="rect" coords="251,56,492,80"/> +<area href="structllfio__v2__xxx_1_1algorithm_1_1reduce__visitor.html" title="A visitor for the filesystem traversal and reduction algorithm." alt="llfio_v2_xxx::algorithm::reduce_visitor" shape="rect" coords="502,56,743,80"/> +<area href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html" title="A visitor for the filesystem traversal and summary algorithm." alt="llfio_v2_xxx::algorithm::summarize_visitor" shape="rect" coords="753,56,994,80"/> + </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:a649d2496caac9dd869eb0ab2e135a0a2"><td class="memItemLeft" align="right" valign="top">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_1traverse__visitor.html#a649d2496caac9dd869eb0ab2e135a0a2">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</td></tr> +<tr class="memdesc:a649d2496caac9dd869eb0ab2e135a0a2"><td class="mdescLeft"> </td><td class="mdescRight">Called when we failed to open a directory for enumeration. The default fails the traversal with that error. Return a default constructed instance to ignore the failure. <a href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#a649d2496caac9dd869eb0ab2e135a0a2">More...</a><br /></td></tr> +<tr class="separator:a649d2496caac9dd869eb0ab2e135a0a2"><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:adcbfbc5dec3d2ab556937a11bdd96937"><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#adcbfbc5dec3d2ab556937a11bdd96937">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</td></tr> +<tr class="memdesc:adcbfbc5dec3d2ab556937a11bdd96937"><td class="mdescLeft"> </td><td class="mdescRight">Called just after each directory enumeration. You can modify the results to affect the traversal, typically you would set the stat to default constructed to cause it to be ignored. You are guaranteed that at least <code>stat.st_type</code> is valid for every entry in <code>contents</code>, and items whose type is a directory will be enqueued after this call for later traversal. <a href="structllfio__v2__xxx_1_1algorithm_1_1traverse__visitor.html#adcbfbc5dec3d2ab556937a11bdd96937">More...</a><br /></td></tr> +<tr class="separator:adcbfbc5dec3d2ab556937a11bdd96937"><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> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A visitor for the filesystem traversal algorithm. </p> +<p>Note that at any time, returning a failure causes <code>traverse()</code> to exit as soon as possible with the same failure. Depth is how deep into the directory hierarchy we are, with zero being the base path handle being traversed. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a649d2496caac9dd869eb0ab2e135a0a2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a649d2496caac9dd869eb0ab2e135a0a2">◆ </a></span>directory_open_failed()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual result<<a class="el" href="classllfio__v2__xxx_1_1directory__handle.html">directory_handle</a>> llfio_v2_xxx::algorithm::traverse_visitor::directory_open_failed </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">result< void >::error_type && </td> + <td class="paramname"><em>error</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"><a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td> + <td class="paramname"><em>leaf</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> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Called when we failed to open a directory for enumeration. The default fails the traversal with that error. Return a default constructed instance to ignore the failure. </p> +<dl class="section note"><dt>Note</dt><dd>May be called from multiple kernel threads concurrently. </dd></dl> + +<p>Reimplemented in <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html#a2d6b2c113d9c3fad2318e9d0e5f83c13">llfio_v2_xxx::algorithm::summarize_visitor</a>, <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1compare__visitor.html#a7ec4aafb16d931783d190cbd8b9c5f7d">llfio_v2_xxx::algorithm::compare_visitor</a>, and <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1reduce__visitor.html#a5af71cbf83dd3c499898f03405a5e698">llfio_v2_xxx::algorithm::reduce_visitor</a>.</p> +<div class="fragment"><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>  (void) data;</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  (void) dirh;</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  (void) leaf;</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  (void) depth;</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> failure(std::move(error));</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div> +</div><!-- fragment --> +</div> +</div> +<a id="adcbfbc5dec3d2ab556937a11bdd96937"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adcbfbc5dec3d2ab556937a11bdd96937">◆ </a></span>post_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<void> llfio_v2_xxx::algorithm::traverse_visitor::post_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"><a class="el" href="structllfio__v2__xxx_1_1directory__handle_1_1buffers__type.html">directory_handle::buffers_type</a> & </td> + <td class="paramname"><em>contents</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> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Called just after each directory enumeration. You can modify the results to affect the traversal, typically you would set the stat to default constructed to cause it to be ignored. You are guaranteed that at least <code>stat.st_type</code> is valid for every entry in <code>contents</code>, and items whose type is a directory will be enqueued after this call for later traversal. </p> +<dl class="section note"><dt>Note</dt><dd>May be called from multiple kernel threads concurrently. </dd></dl> + +<p>Reimplemented in <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1summarize__visitor.html#a35fefdd810e1ce57734832a22916ca05">llfio_v2_xxx::algorithm::summarize_visitor</a>, <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1compare__visitor.html#acec6f86b0ee269eb534f715b2affc5ae">llfio_v2_xxx::algorithm::compare_visitor</a>, <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1reduce__visitor.html#a25405bfa34b4e6d4f2f47babf518f082">llfio_v2_xxx::algorithm::reduce_visitor</a>, and <a class="el" href="structllfio__v2__xxx_1_1algorithm_1_1contents__visitor.html#a21e87fbd21296205b34cbf375d34d74d">llfio_v2_xxx::algorithm::contents_visitor</a>.</p> +<div class="fragment"><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  (void) data;</div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  (void) dirh;</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  (void) <a class="code" href="namespacellfio__v2__xxx_1_1algorithm.html#afae251fc3bfb7280b47b6135e2f6c7e2">contents</a>;</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  (void) depth;</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> success();</div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div> +</div><!-- fragment --> +</div> +</div> +<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> </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> </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="traverse_8hpp.html">traverse.hpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<div class="ttc" id="anamespacellfio__v2__xxx_1_1algorithm_html_afae251fc3bfb7280b47b6135e2f6c7e2"><div class="ttname"><a href="namespacellfio__v2__xxx_1_1algorithm.html#afae251fc3bfb7280b47b6135e2f6c7e2">llfio_v2_xxx::algorithm::contents</a></div><div class="ttdeci">result< contents_visitor::contents_type > contents(const path_handle &dirh, contents_visitor *visitor=nullptr, size_t threads=0, bool force_slow_path=false) noexcept</div><div class="ttdoc">Calculate the contents of everything within and under dirh. What is returned is unordered.</div><div class="ttdef"><b>Definition:</b> contents.hpp:223</div></div> +<!-- 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_1traverse__visitor.html">traverse_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> |