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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AFIO: afio_v2_xxx::path_handle 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="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>
<script type="text/javascript">
$(document).ready(initResizable);
</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">AFIO
 <span id="projectnumber">v2.00 late alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('classafio__v2__xxx_1_1path__handle.html','');});
</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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classafio__v2__xxx_1_1path__handle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">afio_v2_xxx::path_handle Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A handle to somewhere originally identified by a path on the filing system. Typically used as the lightest weight handle to some location on the filing system which may unpredictably relocate over time. This handle is thus an <em>anchor</em> to a subset island of the filing system, free of any race conditions introduced by third party changes to any part of the path leading to that island.
<a href="classafio__v2__xxx_1_1path__handle.html#details">More...</a></p>
<p><code>#include "path_handle.hpp"</code></p>
<div class="dynheader">
Inheritance diagram for afio_v2_xxx::path_handle:</div>
<div class="dyncontent">
<div class="center">
<img src="classafio__v2__xxx_1_1path__handle.png" usemap="#afio_5Fv2_5Fxxx::path_5Fhandle_map" alt=""/>
<map id="afio_5Fv2_5Fxxx::path_5Fhandle_map" name="afio_5Fv2_5Fxxx::path_5Fhandle_map">
<area href="classafio__v2__xxx_1_1handle.html" title="A native_handle_type which is managed by the lifetime of this object instance. " alt="afio_v2_xxx::handle" shape="rect" coords="0,0,181,24"/>
<area href="classafio__v2__xxx_1_1directory__handle.html" title="A handle to a directory which can be enumerated. " alt="afio_v2_xxx::directory_handle" shape="rect" coords="0,112,181,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aff461906ee411a03278d20824201becf"><td class="memItemLeft" align="right" valign="top"><a id="aff461906ee411a03278d20824201becf"></a>
using </td><td class="memItemRight" valign="bottom"><b>path_type</b> = <a class="el" href="classafio__v2__xxx_1_1handle.html#a6c4df2242ece6f63ba7ef4e6baafaca6">handle::path_type</a></td></tr>
<tr class="separator:aff461906ee411a03278d20824201becf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d816c9d7991a84bb85ee225f49ed51a"><td class="memItemLeft" align="right" valign="top"><a id="a8d816c9d7991a84bb85ee225f49ed51a"></a>
using </td><td class="memItemRight" valign="bottom"><b>extent_type</b> = <a class="el" href="classafio__v2__xxx_1_1handle.html#a818fff07c92eaab72532092d1c2a14f9">handle::extent_type</a></td></tr>
<tr class="separator:a8d816c9d7991a84bb85ee225f49ed51a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8373f12c4835eecf6a3dce32eb16cc9e"><td class="memItemLeft" align="right" valign="top"><a id="a8373f12c4835eecf6a3dce32eb16cc9e"></a>
using </td><td class="memItemRight" valign="bottom"><b>size_type</b> = <a class="el" href="classafio__v2__xxx_1_1handle.html#a0adf7fa00e23ed561328f473986e9ccc">handle::size_type</a></td></tr>
<tr class="separator:a8373f12c4835eecf6a3dce32eb16cc9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b2f4b6502b0288170ef25f9d3fdf1c9"><td class="memItemLeft" align="right" valign="top"><a id="a1b2f4b6502b0288170ef25f9d3fdf1c9"></a>
using </td><td class="memItemRight" valign="bottom"><b>mode</b> = <a class="el" href="classafio__v2__xxx_1_1handle.html#a0489b6c1e25cd2bad2ba1ec86e1aaf18">handle::mode</a></td></tr>
<tr class="separator:a1b2f4b6502b0288170ef25f9d3fdf1c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac44deded3ae9cce27e21eed406e0c43"><td class="memItemLeft" align="right" valign="top"><a id="aac44deded3ae9cce27e21eed406e0c43"></a>
using </td><td class="memItemRight" valign="bottom"><b>creation</b> = <a class="el" href="classafio__v2__xxx_1_1handle.html#a45ff5c1c5662623d99156870dfeee0a7">handle::creation</a></td></tr>
<tr class="separator:aac44deded3ae9cce27e21eed406e0c43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af552b17242aec5e4d11466ee8bd99467"><td class="memItemLeft" align="right" valign="top"><a id="af552b17242aec5e4d11466ee8bd99467"></a>
using </td><td class="memItemRight" valign="bottom"><b>caching</b> = <a class="el" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9e">handle::caching</a></td></tr>
<tr class="separator:af552b17242aec5e4d11466ee8bd99467"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78abc121a0d23142d173cd623895a9af"><td class="memItemLeft" align="right" valign="top"><a id="a78abc121a0d23142d173cd623895a9af"></a>
using </td><td class="memItemRight" valign="bottom"><b>flag</b> = handle::flag</td></tr>
<tr class="separator:a78abc121a0d23142d173cd623895a9af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe4d76fd0308667d7b5727c69cfe943f"><td class="memItemLeft" align="right" valign="top"><a id="abe4d76fd0308667d7b5727c69cfe943f"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#abe4d76fd0308667d7b5727c69cfe943f">path_view_type</a> = <a class="el" href="classafio__v2__xxx_1_1path__view.html">path_view</a></td></tr>
<tr class="memdesc:abe4d76fd0308667d7b5727c69cfe943f"><td class="mdescLeft"> </td><td class="mdescRight">The path view type used by this handle. <br /></td></tr>
<tr class="separator:abe4d76fd0308667d7b5727c69cfe943f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6322054d60d251248051cfc15398f608"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608">bitfield__flag</a> : unsigned { <br />
  <a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608aa8a55b902102065962a56dcc6e042329">none</a> = 0,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a334c4a4c42fdb79d7ebc3e73b517e6f8">none</a> = 2,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a334c4a4c42fdb79d7ebc3e73b517e6f8">none</a> = 1,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608acd80b55b5142d39b67a551e89571ad63">unlink_on_first_close</a> = 1U << 0U,
<br />
  <a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a4f263f2b60c1f50f9d400a5e716e1161">disable_safety_fsyncs</a> = 1U << 2U,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a1e39145e0df75a9ce3aa55840f043313">disable_safety_unlinks</a> = 1U << 3U,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a02c4e85b0c96477ae9b1dca791bbcaf6">disable_prefetching</a> = 1U << 4U,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a001904a2d795ae3ed488dbc0d4e10674">maximum_prefetching</a> = 1U << 5U,
<br />
  <a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a36d38379d10e372acfdb98d5ce45cf3a">win_disable_unlink_emulation</a> = 1U << 24U,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a0c0a94f37b843d143876a4ac9f9f92c0">win_disable_sparse_file_creation</a> = 1U << 25U,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a15c37339d7317c534121a29b381aa86c">overlapped</a> = 1U << 28U,
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a94fdec6f1ea4975667ed313208a1d93e">byte_lock_insanity</a> = 1U << 29U,
<br />
  <a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a89d34054589f4846025be042a5e71e14">anonymous_inode</a> = 1U << 30U
<br />
}<tr class="memdesc:a6322054d60d251248051cfc15398f608"><td class="mdescLeft"> </td><td class="mdescRight">Bitwise flags which can be specified. <a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a6322054d60d251248051cfc15398f608"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a3719b4f0ed795cba40d6d35eee62e8ff"><td class="memItemLeft" align="right" valign="top"><a id="a3719b4f0ed795cba40d6d35eee62e8ff"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a3719b4f0ed795cba40d6d35eee62e8ff">path_handle</a> ()</td></tr>
<tr class="memdesc:a3719b4f0ed795cba40d6d35eee62e8ff"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a3719b4f0ed795cba40d6d35eee62e8ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfa0356d4ef899bad7a510f718cbed5f"><td class="memItemLeft" align="right" valign="top"><a id="adfa0356d4ef899bad7a510f718cbed5f"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#adfa0356d4ef899bad7a510f718cbed5f">path_handle</a> (<a class="el" href="structafio__v2__xxx_1_1native__handle__type.html">native_handle_type</a> h, <a class="el" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9e">caching</a> <a class="el" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9e">caching</a>=<a class="el" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9eaa181a603769c1f98ad927e7367c7aa51">caching::all</a>, flag <a class="el" href="classafio__v2__xxx_1_1handle.html#ab3d876f5996605158fd6a0582adadad6">flags</a>=flag::none)</td></tr>
<tr class="memdesc:adfa0356d4ef899bad7a510f718cbed5f"><td class="mdescLeft"> </td><td class="mdescRight">Construct a handle from a supplied native handle. <br /></td></tr>
<tr class="separator:adfa0356d4ef899bad7a510f718cbed5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99b23d7a01380400ee1f69cc840684c1"><td class="memItemLeft" align="right" valign="top"><a id="a99b23d7a01380400ee1f69cc840684c1"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a99b23d7a01380400ee1f69cc840684c1">path_handle</a> (<a class="el" href="classafio__v2__xxx_1_1handle.html">handle</a> &&o) noexcept</td></tr>
<tr class="memdesc:a99b23d7a01380400ee1f69cc840684c1"><td class="mdescLeft"> </td><td class="mdescRight">Explicit conversion from handle permitted. <br /></td></tr>
<tr class="separator:a99b23d7a01380400ee1f69cc840684c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88881e89f538f09c1eaf9447a8182eea"><td class="memItemLeft" align="right" valign="top"><a id="a88881e89f538f09c1eaf9447a8182eea"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a88881e89f538f09c1eaf9447a8182eea">path_handle</a> (<a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> &&)=default</td></tr>
<tr class="memdesc:a88881e89f538f09c1eaf9447a8182eea"><td class="mdescLeft"> </td><td class="mdescRight">Move construction permitted. <br /></td></tr>
<tr class="separator:a88881e89f538f09c1eaf9447a8182eea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a029b99c552a9fda1d4ad95ec8dbe258b"><td class="memItemLeft" align="right" valign="top"><a id="a029b99c552a9fda1d4ad95ec8dbe258b"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a029b99c552a9fda1d4ad95ec8dbe258b">path_handle</a> (const <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> &)=delete</td></tr>
<tr class="memdesc:a029b99c552a9fda1d4ad95ec8dbe258b"><td class="mdescLeft"> </td><td class="mdescRight">No copy construction (use <code>clone()</code>) <br /></td></tr>
<tr class="separator:a029b99c552a9fda1d4ad95ec8dbe258b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47d788871a5090267c3d626a5e35e08a"><td class="memItemLeft" align="right" valign="top"><a id="a47d788871a5090267c3d626a5e35e08a"></a>
<a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a47d788871a5090267c3d626a5e35e08a">operator=</a> (<a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> &&)=default</td></tr>
<tr class="memdesc:a47d788871a5090267c3d626a5e35e08a"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment permitted. <br /></td></tr>
<tr class="separator:a47d788871a5090267c3d626a5e35e08a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35dddd70f7456ee408df76b7d815daaf"><td class="memItemLeft" align="right" valign="top"><a id="a35dddd70f7456ee408df76b7d815daaf"></a>
<a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a35dddd70f7456ee408df76b7d815daaf">operator=</a> (const <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> &)=delete</td></tr>
<tr class="memdesc:a35dddd70f7456ee408df76b7d815daaf"><td class="mdescLeft"> </td><td class="mdescRight">No copy assignment. <br /></td></tr>
<tr class="separator:a35dddd70f7456ee408df76b7d815daaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a657c12a309cf02bf2351bfcc7f41463b"><td class="memItemLeft" align="right" valign="top"><a id="a657c12a309cf02bf2351bfcc7f41463b"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a657c12a309cf02bf2351bfcc7f41463b">swap</a> (<a class="el" href="classafio__v2__xxx_1_1handle.html">handle</a> &o) noexcept</td></tr>
<tr class="memdesc:a657c12a309cf02bf2351bfcc7f41463b"><td class="mdescLeft"> </td><td class="mdescRight">Swap with another instance. <br /></td></tr>
<tr class="separator:a657c12a309cf02bf2351bfcc7f41463b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a616a67222676af5ec5b3aa94d7c02428"><td class="memItemLeft" align="right" valign="top">virtual result< <a class="el" href="classafio__v2__xxx_1_1handle.html#a6c4df2242ece6f63ba7ef4e6baafaca6">path_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a616a67222676af5ec5b3aa94d7c02428">current_path</a> () const noexcept</td></tr>
<tr class="separator:a616a67222676af5ec5b3aa94d7c02428"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4c39abeaa83d990e3bd48fff7b94fb9"><td class="memItemLeft" align="right" valign="top"><a id="af4c39abeaa83d990e3bd48fff7b94fb9"></a>
virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#af4c39abeaa83d990e3bd48fff7b94fb9">close</a> () noexcept</td></tr>
<tr class="memdesc:af4c39abeaa83d990e3bd48fff7b94fb9"><td class="mdescLeft"> </td><td class="mdescRight">Immediately close the native handle type managed by this handle. <br /></td></tr>
<tr class="separator:af4c39abeaa83d990e3bd48fff7b94fb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54790e954f57372b87b095451cc79c38"><td class="memItemLeft" align="right" valign="top">result< <a class="el" href="classafio__v2__xxx_1_1handle.html">handle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a54790e954f57372b87b095451cc79c38">clone</a> () const noexcept</td></tr>
<tr class="separator:a54790e954f57372b87b095451cc79c38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73d5f2070bce0c3d7fa536d3cbed7b52"><td class="memItemLeft" align="right" valign="top"><a id="a73d5f2070bce0c3d7fa536d3cbed7b52"></a>
virtual <a class="el" href="structafio__v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a73d5f2070bce0c3d7fa536d3cbed7b52">release</a> () noexcept</td></tr>
<tr class="memdesc:a73d5f2070bce0c3d7fa536d3cbed7b52"><td class="mdescLeft"> </td><td class="mdescRight">Release the native handle type managed by this handle. <br /></td></tr>
<tr class="separator:a73d5f2070bce0c3d7fa536d3cbed7b52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4194a05dd9694d2c47d5a45f925db1d7"><td class="memItemLeft" align="right" valign="top"><a id="a4194a05dd9694d2c47d5a45f925db1d7"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a4194a05dd9694d2c47d5a45f925db1d7">is_valid</a> () const noexcept</td></tr>
<tr class="memdesc:a4194a05dd9694d2c47d5a45f925db1d7"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is valid (and usually open) <br /></td></tr>
<tr class="separator:a4194a05dd9694d2c47d5a45f925db1d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a349e001cbe359d4e7a8f066c69e9361e"><td class="memItemLeft" align="right" valign="top"><a id="a349e001cbe359d4e7a8f066c69e9361e"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a349e001cbe359d4e7a8f066c69e9361e">is_readable</a> () const noexcept</td></tr>
<tr class="memdesc:a349e001cbe359d4e7a8f066c69e9361e"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is readable. <br /></td></tr>
<tr class="separator:a349e001cbe359d4e7a8f066c69e9361e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5be9a526bc5c1be758b0cfc36a262f6e"><td class="memItemLeft" align="right" valign="top"><a id="a5be9a526bc5c1be758b0cfc36a262f6e"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a5be9a526bc5c1be758b0cfc36a262f6e">is_writable</a> () const noexcept</td></tr>
<tr class="memdesc:a5be9a526bc5c1be758b0cfc36a262f6e"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is writable. <br /></td></tr>
<tr class="separator:a5be9a526bc5c1be758b0cfc36a262f6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae33d4d0faa1377cd371bd6a0ae0769ae"><td class="memItemLeft" align="right" valign="top"><a id="ae33d4d0faa1377cd371bd6a0ae0769ae"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#ae33d4d0faa1377cd371bd6a0ae0769ae">is_append_only</a> () const noexcept</td></tr>
<tr class="memdesc:ae33d4d0faa1377cd371bd6a0ae0769ae"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle is append only. <br /></td></tr>
<tr class="separator:ae33d4d0faa1377cd371bd6a0ae0769ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1610ec7fb0a41f039e3e17e0dc467ab"><td class="memItemLeft" align="right" valign="top">virtual result< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#af1610ec7fb0a41f039e3e17e0dc467ab">set_append_only</a> (bool enable) noexcept</td></tr>
<tr class="separator:af1610ec7fb0a41f039e3e17e0dc467ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af42904dd49b5517a303e7cb256eae939"><td class="memItemLeft" align="right" valign="top"><a id="af42904dd49b5517a303e7cb256eae939"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#af42904dd49b5517a303e7cb256eae939">is_overlapped</a> () const noexcept</td></tr>
<tr class="memdesc:af42904dd49b5517a303e7cb256eae939"><td class="mdescLeft"> </td><td class="mdescRight">True if overlapped. <br /></td></tr>
<tr class="separator:af42904dd49b5517a303e7cb256eae939"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac62f621c42be6eeb8d9a5700da367f9"><td class="memItemLeft" align="right" valign="top"><a id="aac62f621c42be6eeb8d9a5700da367f9"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#aac62f621c42be6eeb8d9a5700da367f9">is_seekable</a> () const noexcept</td></tr>
<tr class="memdesc:aac62f621c42be6eeb8d9a5700da367f9"><td class="mdescLeft"> </td><td class="mdescRight">True if seekable. <br /></td></tr>
<tr class="separator:aac62f621c42be6eeb8d9a5700da367f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affb10caeeca67b804695b7378be29e23"><td class="memItemLeft" align="right" valign="top"><a id="affb10caeeca67b804695b7378be29e23"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#affb10caeeca67b804695b7378be29e23">requires_aligned_io</a> () const noexcept</td></tr>
<tr class="memdesc:affb10caeeca67b804695b7378be29e23"><td class="mdescLeft"> </td><td class="mdescRight">True if requires aligned i/o. <br /></td></tr>
<tr class="separator:affb10caeeca67b804695b7378be29e23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a526c300d421155ccc071b04db4bca65d"><td class="memItemLeft" align="right" valign="top"><a id="a526c300d421155ccc071b04db4bca65d"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a526c300d421155ccc071b04db4bca65d">is_regular</a> () const noexcept</td></tr>
<tr class="memdesc:a526c300d421155ccc071b04db4bca65d"><td class="mdescLeft"> </td><td class="mdescRight">True if a regular file or device. <br /></td></tr>
<tr class="separator:a526c300d421155ccc071b04db4bca65d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa53d88105df8c6be01be649829a65b14"><td class="memItemLeft" align="right" valign="top"><a id="aa53d88105df8c6be01be649829a65b14"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#aa53d88105df8c6be01be649829a65b14">is_directory</a> () const noexcept</td></tr>
<tr class="memdesc:aa53d88105df8c6be01be649829a65b14"><td class="mdescLeft"> </td><td class="mdescRight">True if a directory. <br /></td></tr>
<tr class="separator:aa53d88105df8c6be01be649829a65b14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c777f045dc2b0248b891d6e7811d152"><td class="memItemLeft" align="right" valign="top"><a id="a3c777f045dc2b0248b891d6e7811d152"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a3c777f045dc2b0248b891d6e7811d152">is_symlink</a> () const noexcept</td></tr>
<tr class="memdesc:a3c777f045dc2b0248b891d6e7811d152"><td class="mdescLeft"> </td><td class="mdescRight">True if a symlink. <br /></td></tr>
<tr class="separator:a3c777f045dc2b0248b891d6e7811d152"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab790af4654f5455d8c5e1f1d397543ca"><td class="memItemLeft" align="right" valign="top"><a id="ab790af4654f5455d8c5e1f1d397543ca"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#ab790af4654f5455d8c5e1f1d397543ca">is_multiplexer</a> () const noexcept</td></tr>
<tr class="memdesc:ab790af4654f5455d8c5e1f1d397543ca"><td class="mdescLeft"> </td><td class="mdescRight">True if a multiplexer like BSD kqueues, Linux epoll or Windows IOCP. <br /></td></tr>
<tr class="separator:ab790af4654f5455d8c5e1f1d397543ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad02958278a0d92e4ec4fb864ba1eb35b"><td class="memItemLeft" align="right" valign="top"><a id="ad02958278a0d92e4ec4fb864ba1eb35b"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#ad02958278a0d92e4ec4fb864ba1eb35b">is_process</a> () const noexcept</td></tr>
<tr class="memdesc:ad02958278a0d92e4ec4fb864ba1eb35b"><td class="mdescLeft"> </td><td class="mdescRight">True if a process. <br /></td></tr>
<tr class="separator:ad02958278a0d92e4ec4fb864ba1eb35b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5b2859fabe04dbfc37020daed618257"><td class="memItemLeft" align="right" valign="top"><a id="ac5b2859fabe04dbfc37020daed618257"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#ac5b2859fabe04dbfc37020daed618257">is_section</a> () const noexcept</td></tr>
<tr class="memdesc:ac5b2859fabe04dbfc37020daed618257"><td class="mdescLeft"> </td><td class="mdescRight">True if a memory section. <br /></td></tr>
<tr class="separator:ac5b2859fabe04dbfc37020daed618257"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00f42a44de714feb3ed86dd0a175e69c"><td class="memItemLeft" align="right" valign="top"><a id="a00f42a44de714feb3ed86dd0a175e69c"></a>
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9e">caching</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a00f42a44de714feb3ed86dd0a175e69c">kernel_caching</a> () const noexcept</td></tr>
<tr class="memdesc:a00f42a44de714feb3ed86dd0a175e69c"><td class="mdescLeft"> </td><td class="mdescRight">Kernel cache strategy used by this handle. <br /></td></tr>
<tr class="separator:a00f42a44de714feb3ed86dd0a175e69c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a71137cb82edd9a1bcb24f64886b5826d"><td class="memItemLeft" align="right" valign="top"><a id="a71137cb82edd9a1bcb24f64886b5826d"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a71137cb82edd9a1bcb24f64886b5826d">are_reads_from_cache</a> () const noexcept</td></tr>
<tr class="memdesc:a71137cb82edd9a1bcb24f64886b5826d"><td class="mdescLeft"> </td><td class="mdescRight">True if the handle uses the kernel page cache for reads. <br /></td></tr>
<tr class="separator:a71137cb82edd9a1bcb24f64886b5826d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97ffbbf53f51549549efef0b49e125dc"><td class="memItemLeft" align="right" valign="top"><a id="a97ffbbf53f51549549efef0b49e125dc"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a97ffbbf53f51549549efef0b49e125dc">are_writes_durable</a> () const noexcept</td></tr>
<tr class="memdesc:a97ffbbf53f51549549efef0b49e125dc"><td class="mdescLeft"> </td><td class="mdescRight">True if writes are safely on storage on completion. <br /></td></tr>
<tr class="separator:a97ffbbf53f51549549efef0b49e125dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3fc7db93fac699f5ecad453642ed314e"><td class="memItemLeft" align="right" valign="top"><a id="a3fc7db93fac699f5ecad453642ed314e"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a3fc7db93fac699f5ecad453642ed314e">are_safety_fsyncs_issued</a> () const noexcept</td></tr>
<tr class="memdesc:a3fc7db93fac699f5ecad453642ed314e"><td class="mdescLeft"> </td><td class="mdescRight">True if issuing safety fsyncs is on. <br /></td></tr>
<tr class="separator:a3fc7db93fac699f5ecad453642ed314e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3d876f5996605158fd6a0582adadad6"><td class="memItemLeft" align="right" valign="top"><a id="ab3d876f5996605158fd6a0582adadad6"></a>
flag </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#ab3d876f5996605158fd6a0582adadad6">flags</a> () const noexcept</td></tr>
<tr class="memdesc:ab3d876f5996605158fd6a0582adadad6"><td class="mdescLeft"> </td><td class="mdescRight">The flags this handle was opened with. <br /></td></tr>
<tr class="separator:ab3d876f5996605158fd6a0582adadad6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a875440f1b368472f1840c70c266f3a48"><td class="memItemLeft" align="right" valign="top"><a id="a875440f1b368472f1840c70c266f3a48"></a>
<a class="el" href="structafio__v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1handle.html#a875440f1b368472f1840c70c266f3a48">native_handle</a> () const noexcept</td></tr>
<tr class="memdesc:a875440f1b368472f1840c70c266f3a48"><td class="mdescLeft"> </td><td class="mdescRight">The native handle used by this handle. <br /></td></tr>
<tr class="separator:a875440f1b368472f1840c70c266f3a48"><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:af6e7168b01cf2e1eefdc190ec4a52c8f"><td class="memItemLeft" align="right" valign="top">static result< <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#af6e7168b01cf2e1eefdc190ec4a52c8f">path</a> (const <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> &base, <a class="el" href="classafio__v2__xxx_1_1path__handle.html#abe4d76fd0308667d7b5727c69cfe943f">path_view_type</a> path) noexcept</td></tr>
<tr class="separator:af6e7168b01cf2e1eefdc190ec4a52c8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55d9de8f40e86dc1b657f3905d9a1e61"><td class="memItemLeft" align="right" valign="top">static result< <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#a55d9de8f40e86dc1b657f3905d9a1e61">path</a> (<a class="el" href="classafio__v2__xxx_1_1path__handle.html#abe4d76fd0308667d7b5727c69cfe943f">path_view_type</a> _path) noexcept</td></tr>
<tr class="separator:a55d9de8f40e86dc1b657f3905d9a1e61"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af024e3d92d9a01ac367734e9cdc517fb"><td class="memItemLeft" align="right" valign="top"><a id="af024e3d92d9a01ac367734e9cdc517fb"></a>
<a class="el" href="classafio__v2__xxx_1_1handle.html#a6f7e37c73271968271c2342023f58c9e">caching</a> </td><td class="memItemRight" valign="bottom"><b>_caching</b> {<a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a334c4a4c42fdb79d7ebc3e73b517e6f8">caching::none</a>}</td></tr>
<tr class="separator:af024e3d92d9a01ac367734e9cdc517fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac46e0a296c31fcd0a996a79d78647fb6"><td class="memItemLeft" align="right" valign="top"><a id="ac46e0a296c31fcd0a996a79d78647fb6"></a>
flag </td><td class="memItemRight" valign="bottom"><b>_flags</b> {flag::none}</td></tr>
<tr class="separator:ac46e0a296c31fcd0a996a79d78647fb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a771ef2bf39ad784eb6265dde077792ad"><td class="memItemLeft" align="right" valign="top"><a id="a771ef2bf39ad784eb6265dde077792ad"></a>
<a class="el" href="structafio__v2__xxx_1_1native__handle__type.html">native_handle_type</a> </td><td class="memItemRight" valign="bottom"><b>_v</b></td></tr>
<tr class="separator:a771ef2bf39ad784eb6265dde077792ad"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ab98213f3667f45cc5429e9d6ed6073fb"><td class="memItemLeft" align="right" valign="top"><a id="ab98213f3667f45cc5429e9d6ed6073fb"></a>
class </td><td class="memItemRight" valign="bottom"><b>directory_handle</b></td></tr>
<tr class="separator:ab98213f3667f45cc5429e9d6ed6073fb"><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 handle to somewhere originally identified by a path on the filing system. Typically used as the lightest weight handle to some location on the filing system which may unpredictably relocate over time. This handle is thus an <em>anchor</em> to a subset island of the filing system, free of any race conditions introduced by third party changes to any part of the path leading to that island. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a6322054d60d251248051cfc15398f608"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6322054d60d251248051cfc15398f608">◆ </a></span>bitfield__flag</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608">afio_v2_xxx::handle::bitfield__flag</a> : unsigned</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Bitwise flags which can be specified. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608aa8a55b902102065962a56dcc6e042329"></a>none </td><td class="fielddoc"><p>No flags. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>No ability to read or write anything, but can synchronise (SYNCHRONIZE or 0) </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>No caching whatsoever, all reads and writes come from storage (i.e. <code>O_DIRECT|O_SYNC</code>). Align all i/o to 4Kb boundaries for this to work. <code>flag_disable_safety_fsyncs</code> can be used here. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608acd80b55b5142d39b67a551e89571ad63"></a>unlink_on_first_close </td><td class="fielddoc"><p>Unlinks the file on handle close. On POSIX, this simply unlinks whatever is pointed to by <code>path()</code> upon the call of <code>close()</code> if and only if the inode matches. On Windows, if you are on Windows 10 1709 or later, exactly the same thing occurs. If on previous editions of Windows, the file entry does not disappears but becomes unavailable for anyone else to open with an <code>errc::resource_unavailable_try_again</code> error return. Because this is confusing, unless the <code>win_disable_unlink_emulation</code> flag is also specified, this POSIX behaviour is somewhat emulated by AFIO on older Windows by renaming the file to a random name on <code>close()</code> causing it to appear to have been unlinked immediately. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a4f263f2b60c1f50f9d400a5e716e1161"></a>disable_safety_fsyncs </td><td class="fielddoc"><p>Some kernel caching modes have unhelpfully inconsistent behaviours in getting your data onto storage, so by default unless this flag is specified AFIO adds extra fsyncs to the following operations for the caching modes specified below: truncation of file length either explicitly or during file open. closing of the handle either explicitly or in the destructor.</p>
<p>Additionally on Linux only to prevent loss of file metadata: On the parent directory whenever a file might have been created. On the parent directory on file close.</p>
<p>This only occurs for these kernel caching modes: caching::none caching::reads caching::reads_and_metadata caching::safety_fsyncs </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a1e39145e0df75a9ce3aa55840f043313"></a>disable_safety_unlinks </td><td class="fielddoc"><p><code>file_handle::unlink()</code> could accidentally delete the wrong file if someone has renamed the open file handle since the time it was opened. To prevent this occuring, where the OS doesn't provide race free unlink-by-open-handle we compare the inode of the path we are about to unlink with that of the open handle before unlinking. </p><dl class="section warning"><dt>Warning</dt><dd>This does not prevent races where in between the time of checking the inode and executing the unlink a third party changes the item about to be unlinked. Only operating systems with a true race-free unlink syscall are race free. </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a02c4e85b0c96477ae9b1dca791bbcaf6"></a>disable_prefetching </td><td class="fielddoc"><p>Ask the OS to disable prefetching of data. This can improve random i/o performance. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a001904a2d795ae3ed488dbc0d4e10674"></a>maximum_prefetching </td><td class="fielddoc"><p>Ask the OS to maximise prefetching of data, possibly prefetching the entire file into kernel cache. This can improve sequential i/o performance. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a36d38379d10e372acfdb98d5ce45cf3a"></a>win_disable_unlink_emulation </td><td class="fielddoc"><p>See the documentation for <code>unlink_on_first_close</code> </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a0c0a94f37b843d143876a4ac9f9f92c0"></a>win_disable_sparse_file_creation </td><td class="fielddoc"><p>Microsoft Windows NTFS, having been created in the late 1980s, did not originally implement extents-based storage and thus could only represent sparse files via efficient compression of intermediate zeros. With NTFS v3.0 (Microsoft Windows 2000), a proper extents-based on-storage representation was added, thus allowing only 64Kb extent chunks written to be stored irrespective of whatever the maximum file extent was set to.</p>
<p>For various historical reasons, extents-based storage is disabled by default in newly created files on NTFS, unlike in almost every other major filing system. You have to explicitly "opt in" to extents-based storage.</p>
<p>As extents-based storage is nearly cost free on NTFS, AFIO by default opts in to extents-based storage for any empty file it creates. If you don't want this, you can specify this flag to prevent that happening. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a15c37339d7317c534121a29b381aa86c"></a>overlapped </td><td class="fielddoc"><p>On Windows, create any new handles with OVERLAPPED semantics. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a94fdec6f1ea4975667ed313208a1d93e"></a>byte_lock_insanity </td><td class="fielddoc"><p>Using insane POSIX byte range locks. </p>
</td></tr>
<tr><td class="fieldname"><a id="a6322054d60d251248051cfc15398f608a89d34054589f4846025be042a5e71e14"></a>anonymous_inode </td><td class="fielddoc"><p>This is an inode created with no representation on the filing system. </p>
</td></tr>
</table>
<div class="fragment"><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608aa8a55b902102065962a56dcc6e042329">none</a> = 0, <span class="comment">//!< No flags</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span><span class="comment"> /*! Unlinks the file on handle close. On POSIX, this simply unlinks whatever is pointed</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> to by `path()` upon the call of `close()` if and only if the inode matches. On Windows,</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> if you are on Windows 10 1709 or later, exactly the same thing occurs. If on previous</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> editions of Windows, the file entry does not disappears but becomes unavailable for</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> anyone else to open with an `errc::resource_unavailable_try_again` error return. Because this is confusing, unless the</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> `win_disable_unlink_emulation` flag is also specified, this POSIX behaviour is</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> somewhat emulated by AFIO on older Windows by renaming the file to a random name on `close()`</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> causing it to appear to have been unlinked immediately.</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> */</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608acd80b55b5142d39b67a551e89571ad63">unlink_on_first_close</a> = 1U << 0U,</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /*! Some kernel caching modes have unhelpfully inconsistent behaviours</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> in getting your data onto storage, so by default unless this flag is</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> specified AFIO adds extra fsyncs to the following operations for the</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> caching modes specified below:</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * truncation of file length either explicitly or during file open.</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * closing of the handle either explicitly or in the destructor.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> Additionally on Linux only to prevent loss of file metadata:</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * On the parent directory whenever a file might have been created.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * On the parent directory on file close.</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> This only occurs for these kernel caching modes:</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * caching::none</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * caching::reads</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * caching::reads_and_metadata</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * caching::safety_fsyncs</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a4f263f2b60c1f50f9d400a5e716e1161">disable_safety_fsyncs</a> = 1U << 2U,<span class="comment"></span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /*! `file_handle::unlink()` could accidentally delete the wrong file if someone has</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> renamed the open file handle since the time it was opened. To prevent this occuring,</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> where the OS doesn't provide race free unlink-by-open-handle we compare the inode of</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> the path we are about to unlink with that of the open handle before unlinking.</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> \warning This does not prevent races where in between the time of checking the inode</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> and executing the unlink a third party changes the item about to be unlinked. Only</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> operating systems with a true race-free unlink syscall are race free.</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> */</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a1e39145e0df75a9ce3aa55840f043313">disable_safety_unlinks</a> = 1U << 3U,<span class="comment"></span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /*! Ask the OS to disable prefetching of data. This can improve random</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> i/o performance.</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> */</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a02c4e85b0c96477ae9b1dca791bbcaf6">disable_prefetching</a> = 1U << 4U,<span class="comment"></span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /*! Ask the OS to maximise prefetching of data, possibly prefetching the entire file</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> into kernel cache. This can improve sequential i/o performance.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> */</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a001904a2d795ae3ed488dbc0d4e10674">maximum_prefetching</a> = 1U << 5U,</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a36d38379d10e372acfdb98d5ce45cf3a">win_disable_unlink_emulation</a> = 1U << 24U, <span class="comment">//!< See the documentation for `unlink_on_first_close`</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"></span><span class="comment"> /*! Microsoft Windows NTFS, having been created in the late 1980s, did not originally</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> implement extents-based storage and thus could only represent sparse files via</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> efficient compression of intermediate zeros. With NTFS v3.0 (Microsoft Windows 2000),</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> a proper extents-based on-storage representation was added, thus allowing only 64Kb</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> extent chunks written to be stored irrespective of whatever the maximum file extent</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> was set to.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> For various historical reasons, extents-based storage is disabled by default in newly</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> created files on NTFS, unlike in almost every other major filing system. You have to</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> explicitly "opt in" to extents-based storage.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"></span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> As extents-based storage is nearly cost free on NTFS, AFIO by default opts in to</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> extents-based storage for any empty file it creates. If you don't want this, you</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> can specify this flag to prevent that happening.</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> */</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a0c0a94f37b843d143876a4ac9f9f92c0">win_disable_sparse_file_creation</a> = 1U << 25U,</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="comment">// NOTE: IF UPDATING THIS UPDATE THE std::ostream PRINTER BELOW!!!</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a15c37339d7317c534121a29b381aa86c">overlapped</a> = 1U << 28U, <span class="comment">//!< On Windows, create any new handles with OVERLAPPED semantics</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"></span> <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a94fdec6f1ea4975667ed313208a1d93e">byte_lock_insanity</a> = 1U << 29U, <span class="comment">//!< Using insane POSIX byte range locks</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"></span> <a class="code" href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a89d34054589f4846025be042a5e71e14">anonymous_inode</a> = 1U << 30U <span class="comment">//!< This is an inode created with no representation on the filing system</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"></span> }</div><div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a02c4e85b0c96477ae9b1dca791bbcaf6"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a02c4e85b0c96477ae9b1dca791bbcaf6">afio_v2_xxx::handle::disable_prefetching</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:140</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a36d38379d10e372acfdb98d5ce45cf3a"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a36d38379d10e372acfdb98d5ce45cf3a">afio_v2_xxx::handle::win_disable_unlink_emulation</a></div><div class="ttdoc">See the documentation for unlink_on_first_close </div><div class="ttdef"><b>Definition:</b> handle.hpp:146</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a89d34054589f4846025be042a5e71e14"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a89d34054589f4846025be042a5e71e14">afio_v2_xxx::handle::anonymous_inode</a></div><div class="ttdoc">This is an inode created with no representation on the filing system. </div><div class="ttdef"><b>Definition:</b> handle.hpp:168</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a001904a2d795ae3ed488dbc0d4e10674"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a001904a2d795ae3ed488dbc0d4e10674">afio_v2_xxx::handle::maximum_prefetching</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:144</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a4f263f2b60c1f50f9d400a5e716e1161"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a4f263f2b60c1f50f9d400a5e716e1161">afio_v2_xxx::handle::disable_safety_fsyncs</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:127</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a0c0a94f37b843d143876a4ac9f9f92c0"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a0c0a94f37b843d143876a4ac9f9f92c0">afio_v2_xxx::handle::win_disable_sparse_file_creation</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:162</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608acd80b55b5142d39b67a551e89571ad63"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608acd80b55b5142d39b67a551e89571ad63">afio_v2_xxx::handle::unlink_on_first_close</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:108</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a1e39145e0df75a9ce3aa55840f043313"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a1e39145e0df75a9ce3aa55840f043313">afio_v2_xxx::handle::disable_safety_unlinks</a></div><div class="ttdef"><b>Definition:</b> handle.hpp:136</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a15c37339d7317c534121a29b381aa86c"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a15c37339d7317c534121a29b381aa86c">afio_v2_xxx::handle::overlapped</a></div><div class="ttdoc">On Windows, create any new handles with OVERLAPPED semantics. </div><div class="ttdef"><b>Definition:</b> handle.hpp:166</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608aa8a55b902102065962a56dcc6e042329"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608aa8a55b902102065962a56dcc6e042329">afio_v2_xxx::handle::none</a></div><div class="ttdoc">No flags. </div><div class="ttdef"><b>Definition:</b> handle.hpp:98</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1handle_html_a6322054d60d251248051cfc15398f608a94fdec6f1ea4975667ed313208a1d93e"><div class="ttname"><a href="classafio__v2__xxx_1_1handle.html#a6322054d60d251248051cfc15398f608a94fdec6f1ea4975667ed313208a1d93e">afio_v2_xxx::handle::byte_lock_insanity</a></div><div class="ttdoc">Using insane POSIX byte range locks. </div><div class="ttdef"><b>Definition:</b> handle.hpp:167</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a54790e954f57372b87b095451cc79c38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54790e954f57372b87b095451cc79c38">◆ </a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">result<<a class="el" href="classafio__v2__xxx_1_1handle.html">handle</a>> afio_v2_xxx::handle::clone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clone this handle (copy constructor is disabled to avoid accidental copying)</p>
<dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX dup() or DuplicateHandle() can return. </dd></dl>
</div>
</div>
<a id="a616a67222676af5ec5b3aa94d7c02428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a616a67222676af5ec5b3aa94d7c02428">◆ </a></span>current_path()</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="classafio__v2__xxx_1_1handle.html#a6c4df2242ece6f63ba7ef4e6baafaca6">path_type</a>> afio_v2_xxx::handle::current_path </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns the current path of the open handle as said by the operating system. Note that you are NOT guaranteed that any path refreshed bears any resemblance to the original, some operating systems will return some different path which still reaches the same inode via some other route e.g. hardlinks, dereferenced symbolic links, etc. Windows and Linux correctly track changes to the specific path the handle was opened with, not getting confused by other hard links. MacOS nearly gets it right, but under some circumstances e.g. renaming may switch to a different hard link's path which is almost certainly a bug.</p>
<p>If AFIO was not able to determine the current path for this open handle e.g. the inode has been unlinked, it returns an empty path. Be aware that FreeBSD can return an empty (deleted) path for file inodes no longer cached by the kernel path cache, AFIO cannot detect the difference. FreeBSD will also return any path leading to the inode if it is hard linked. FreeBSD does implement path retrieval for directory inodes correctly however, and see <code>algorithm::stablized_path<T></code> for a handle adapter which makes use of that.</p>
<p>On Linux if <code>/proc</code> is not mounted, this call fails with an error. All APIs in AFIO which require the use of <code>current_path()</code> can be told to not use it e.g. <code>flag::disable_safety_unlinks</code>. It is up to you to detect if <code>current_path()</code> is not working, and to change how you call AFIO appropriately.</p>
<dl class="section warning"><dt>Warning</dt><dd>This call is expensive, it always asks the kernel for the current path, and no checking is done to ensure what the kernel returns is accurate or even sensible. Be aware that despite these precautions, paths are unstable and <b>can change randomly at any moment</b>. Most code written to use absolute file systems paths is <b>racy</b>, so don't do it, use <code>path_handle</code> to fix a base location on the file system and work from that anchor instead!</dd></dl>
<dl class="section user"><dt>Memory Allocations</dt><dd>At least one malloc for the <code>path_type</code>, likely several more. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><code>algorithm::cached_parent_handle_adapter<T></code> which overrides this with an implementation based on retrieving the current path of a cached handle to the parent directory. On platforms with instability or failure to retrieve the correct current path for regular files, the cached parent handle adapter works around the problem by taking advantage of directory inodes not having the same instability problems on any platform. </dd></dl>
</div>
</div>
<a id="af6e7168b01cf2e1eefdc190ec4a52c8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6e7168b01cf2e1eefdc190ec4a52c8f">◆ </a></span>path() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static result<<a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a>> afio_v2_xxx::path_handle::path </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a> & </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#abe4d76fd0308667d7b5727c69cfe943f">path_view_type</a> </td>
<td class="paramname"><em>path</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">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a path handle opening access to some location on the filing system. Some operating systems provide a particularly lightweight method of doing this (Linux: <code>O_PATH</code>, Windows: no access perms) which is much faster than opening a directory. For other systems, we open a directory with read only permissions.</p>
<dl class="section user"><dt>Errors returnable</dt><dd>Any of the values POSIX open() or CreateFile() can return. </dd></dl>
</div>
</div>
<a id="a55d9de8f40e86dc1b657f3905d9a1e61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55d9de8f40e86dc1b657f3905d9a1e61">◆ </a></span>path() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static result<<a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</a>> afio_v2_xxx::path_handle::path </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classafio__v2__xxx_1_1path__handle.html#abe4d76fd0308667d7b5727c69cfe943f">path_view_type</a> </td>
<td class="paramname"><em>_path</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<div class="fragment"><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> { <span class="keywordflow">return</span> <a class="code" href="classafio__v2__xxx_1_1path__handle.html#af6e7168b01cf2e1eefdc190ec4a52c8f">path</a>(<a class="code" href="classafio__v2__xxx_1_1path__handle.html#a3719b4f0ed795cba40d6d35eee62e8ff">path_handle</a>(), _path); }</div><div class="ttc" id="classafio__v2__xxx_1_1path__handle_html_af6e7168b01cf2e1eefdc190ec4a52c8f"><div class="ttname"><a href="classafio__v2__xxx_1_1path__handle.html#af6e7168b01cf2e1eefdc190ec4a52c8f">afio_v2_xxx::path_handle::path</a></div><div class="ttdeci">static result< path_handle > path(const path_handle &base, path_view_type path) noexcept</div></div>
<div class="ttc" id="classafio__v2__xxx_1_1path__handle_html_a3719b4f0ed795cba40d6d35eee62e8ff"><div class="ttname"><a href="classafio__v2__xxx_1_1path__handle.html#a3719b4f0ed795cba40d6d35eee62e8ff">afio_v2_xxx::path_handle::path_handle</a></div><div class="ttdeci">constexpr path_handle()</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> path_handle.hpp:66</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="af1610ec7fb0a41f039e3e17e0dc467ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1610ec7fb0a41f039e3e17e0dc467ab">◆ </a></span>set_append_only()</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> afio_v2_xxx::handle::set_append_only </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>enable</em></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>Changes whether this handle is append only or not.</p>
<dl class="section warning"><dt>Warning</dt><dd>On Windows this is implemented as a bit of a hack to make it fast like on POSIX, so make sure you open the handle for read/write originally. Note unlike on POSIX the append_only disposition will be the only one toggled, seekable and readable will remain turned on.</dd></dl>
<dl class="section user"><dt>Errors returnable</dt><dd>Whatever POSIX fcntl() returns. On Windows nothing is changed on the handle. </dd></dl>
<dl class="section user"><dt>Memory Allocations</dt><dd>No memory allocation. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/afio/v2.0/<a class="el" href="path__handle_8hpp.html">path_handle.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="namespaceafio__v2__xxx.html">afio_v2_xxx</a></li><li class="navelem"><a class="el" href="classafio__v2__xxx_1_1path__handle.html">path_handle</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.13 </li>
</ul>
</div>
</body>
</html>
|
