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
|
[/============================================================================
Boost.AFIO
Use, modification and distribution is subject to the Boost Software License,
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]
[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml\classboost_1_1afio_1_1directory__entry.xml]
[section:directory_entry directory_entry]
'''<?dbhtml-include href="disqus_identifiers/directory_entry.html"?>'''
'''<indexterm><primary>directory_entry</primary></indexterm>'''
The abstract base class for an entry in a directory with lazily filled metadata.
[heading Description]
Note that [^`directory_entry_hash`] will hash one of these for you, and a [^`std::hash<``directory_entry``>`] specialisation is defined for you so you ought to be able to use directory\u005fentry directly in an [^`unordered_map<>`].
See [^`__afio_stat_t__`] for explanations of the fields.
[heading Synopsis]
``class directory_entry
{
// ...
};
``
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
[[``directory_entry()``
] [Default constructor. ] [
]]
[[``directory_entry(path::string_type _leafname, stat_t __stat, metadata_flags _have_metadata)``
] [Default constructor. ] [[* path::string_type]: ['_leafname]:
[* stat_t]: ['__stat]:
[* metadata_flags]: ['_have_metadata]:
]]
[[``directory_entry(const directory_entry & )``
] [] [[* const directory_entry &]: [']:
]]
[[``directory_entry(directory_entry && o)``
] [] [[* directory_entry &&]: ['o]:
]]
]
[heading Member Function(s)]
[table
[[Function] [Description] [Parameters] [Returns]]
[[``directory_entry & operator=(const directory_entry & )``
] [] [[* const directory_entry &]: [']:
][
]
]
[[``directory_entry & operator=(directory_entry && o)``
] [] [[* directory_entry &&]: ['o]:
][
]
]
[[``bool operator==(const directory_entry & rhs)``
] [] [[* const directory_entry &]: ['rhs]:
][
]
]
[[``bool operator!=(const directory_entry & rhs)``
] [] [[* const directory_entry &]: ['rhs]:
][
]
]
[[``bool operator<(const directory_entry & rhs)``
] [] [[* const directory_entry &]: ['rhs]:
][
]
]
[[``bool operator<=(const directory_entry & rhs)``
] [] [[* const directory_entry &]: ['rhs]:
][
]
]
[[``bool operator>(const directory_entry & rhs)``
] [] [[* const directory_entry &]: ['rhs]:
][
]
]
[[``bool operator>=(const directory_entry & rhs)``
] [] [[* const directory_entry &]: ['rhs]:
][
]
]
[[``path::string_type name()``
] [] [
][
The name of the directory entry. May be empty if the file is deleted.
]
]
[[``metadata_flags metadata_ready()``
] [] [
][
A bitfield of what metadata is ready right now
]
]
[[``metadata_flags fetch_metadata(handle_ptr dirh, metadata_flags wanted)``
] [Fetches the specified metadata, returning that newly available. This is a blocking call if wanted metadata is not yet ready. Note that if the call blocks and the leafname no longer exists or the directory handle is null, an exception is thrown. ] [[* handle_ptr]: ['dirh]: An open handle to the entry's containing directory. You can get this from an op ref using dirop.get_handle().
[* metadata_flags]: ['wanted]: A bitfield of the metadata to fetch. This does not replace existing metadata.
][
The metadata now available in this directory entry.
]
]
[[``stat_t fetch_lstat(handle_ptr dirh, metadata_flags wanted = directory_entry::metadata_fastpath())``
] [Returns a copy of the internal [^`stat_t`] structure. This is a blocking call if wanted metadata is not yet ready. Note that if the call blocks and the leafname no longer exists or the directory handle is null, an exception is thrown. ] [[* handle_ptr]: ['dirh]: An open handle to the entry's containing directory. You can get this from an op ref using dirop.get_handle().
[* metadata_flags]: ['wanted]: A bitfield of the metadata to fetch. This does not replace existing metadata.
][
A copy of the internal [^`stat_t`] structure.
]
]
[[``fieldtype st_dev(handle_ptr dirh = handle_ptr())``
] [Returns st_dev. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_ino(handle_ptr dirh = handle_ptr())``
] [Returns st_ino. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_type(handle_ptr dirh = handle_ptr())``
] [Returns st_type. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_perms(handle_ptr dirh = handle_ptr())``
] [Returns st_perms. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_nlink(handle_ptr dirh = handle_ptr())``
] [Returns st_nlink. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_uid(handle_ptr dirh = handle_ptr())``
] [Returns st_uid. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_gid(handle_ptr dirh = handle_ptr())``
] [Returns st_gid. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_rdev(handle_ptr dirh = handle_ptr())``
] [Returns st_rdev. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_atim(handle_ptr dirh = handle_ptr())``
] [Returns st_atim. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_mtim(handle_ptr dirh = handle_ptr())``
] [Returns st_mtim. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_ctim(handle_ptr dirh = handle_ptr())``
] [Returns st_ctim. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_size(handle_ptr dirh = handle_ptr())``
] [Returns st_size. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_allocated(handle_ptr dirh = handle_ptr())``
] [Returns st_allocated. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_blocks(handle_ptr dirh = handle_ptr())``
] [Returns st_blocks. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_blksize(handle_ptr dirh = handle_ptr())``
] [Returns st_blksize. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_flags(handle_ptr dirh = handle_ptr())``
] [Returns st_flags. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_gen(handle_ptr dirh = handle_ptr())``
] [Returns st_gen. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``fieldtype st_birthtim(handle_ptr dirh = handle_ptr())``
] [Returns st_birthtim. ] [[* handle_ptr]: ['dirh]: An optional open handle to the entry's containing directory if fetching missing metadata is desired (an exception is thrown otherwise). You can get this from an op ref using dirop.get_handle().
][
]
]
[[``metadata_flags metadata_supported()``
] [A bitfield of what metadata is available on this platform. This doesn't mean all is available for every filing system. ] [
][
]
]
[[``metadata_flags metadata_fastpath()``
] [A bitfield of what metadata is fast on this platform. This doesn't mean all is available for every filing system. ] [
][
]
]
[[``size_t compatibility_maximum()``
] [The maximum number of entries which is "usual" to fetch at once i.e. what your libc does. ] [
][
]
]
]
[heading Header]
`#include <boost/afio/v2/afio.hpp>`
[include generated/struct_directory_entry_hash.qbk]
'''<?dbhtml-include href="disqus_comments.html"?>'''
[endsect]
|
