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
|
<!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>LLFIO: llfio_v2_xxx::path_view 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">LLFIO
 <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('classllfio__v2__xxx_1_1path__view.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="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classllfio__v2__xxx_1_1path__view-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">llfio_v2_xxx::path_view Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A borrowed view of a path. A lightweight trivial-type alternative to <code>std::filesystem::path</code>.
<a href="classllfio__v2__xxx_1_1path__view.html#details">More...</a></p>
<p><code>#include "path_view.hpp"</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structllfio__v2__xxx_1_1path__view_1_1c__str.html">c_str</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Instantiate from a <code>path_view</code> to get a zero terminated path suitable for feeding to the kernel. <a href="structllfio__v2__xxx_1_1path__view_1_1c__str.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:ac797abdc80bbd5f5b94ccb4e30117cbb"><td class="memItemLeft" align="right" valign="top"><a id="ac797abdc80bbd5f5b94ccb4e30117cbb"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ac797abdc80bbd5f5b94ccb4e30117cbb">size_type</a> = std::size_t</td></tr>
<tr class="memdesc:ac797abdc80bbd5f5b94ccb4e30117cbb"><td class="mdescLeft"> </td><td class="mdescRight">Size type. <br /></td></tr>
<tr class="separator:ac797abdc80bbd5f5b94ccb4e30117cbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4e14fc71abee0765b06af857bd6a025"><td class="memItemLeft" align="right" valign="top"><a id="ad4e14fc71abee0765b06af857bd6a025"></a>
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ad4e14fc71abee0765b06af857bd6a025">difference_type</a> = std::ptrdiff_t</td></tr>
<tr class="memdesc:ad4e14fc71abee0765b06af857bd6a025"><td class="mdescLeft"> </td><td class="mdescRight">Difference type. <br /></td></tr>
<tr class="separator:ad4e14fc71abee0765b06af857bd6a025"><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:a91540ade852194b9507184cdcaed3339"><td class="memItemLeft" align="right" valign="top"><a id="a91540ade852194b9507184cdcaed3339"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a91540ade852194b9507184cdcaed3339">path_view</a> ()</td></tr>
<tr class="memdesc:a91540ade852194b9507184cdcaed3339"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an empty path view. <br /></td></tr>
<tr class="separator:a91540ade852194b9507184cdcaed3339"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab423783d2a907166248f3074f3750045"><td class="memItemLeft" align="right" valign="top"><a id="ab423783d2a907166248f3074f3750045"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ab423783d2a907166248f3074f3750045">path_view</a> (const filesystem::path &v) noexcept</td></tr>
<tr class="memdesc:ab423783d2a907166248f3074f3750045"><td class="mdescLeft"> </td><td class="mdescRight">Implicitly constructs a path view from a path. The input path MUST continue to exist for this view to be valid. <br /></td></tr>
<tr class="separator:ab423783d2a907166248f3074f3750045"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cc50365ca2d2ca528ecfd4d4d9d2205"><td class="memItemLeft" align="right" valign="top"><a id="a5cc50365ca2d2ca528ecfd4d4d9d2205"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a5cc50365ca2d2ca528ecfd4d4d9d2205">path_view</a> (const std::string &v) noexcept</td></tr>
<tr class="memdesc:a5cc50365ca2d2ca528ecfd4d4d9d2205"><td class="mdescLeft"> </td><td class="mdescRight">Implicitly constructs a UTF-8 path view from a string. The input string MUST continue to exist for this view to be valid. <br /></td></tr>
<tr class="separator:a5cc50365ca2d2ca528ecfd4d4d9d2205"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a711521276cb79a9483a27bf5692ab30d"><td class="memItemLeft" align="right" valign="top"><a id="a711521276cb79a9483a27bf5692ab30d"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a711521276cb79a9483a27bf5692ab30d">path_view</a> (const char *v) noexcept</td></tr>
<tr class="memdesc:a711521276cb79a9483a27bf5692ab30d"><td class="mdescLeft"> </td><td class="mdescRight">Implicitly constructs a UTF-8 path view from a zero terminated <code>const char *</code>. The input string MUST continue to exist for this view to be valid. <br /></td></tr>
<tr class="separator:a711521276cb79a9483a27bf5692ab30d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc3b043b782b88100272b556388b9e4d"><td class="memItemLeft" align="right" valign="top"><a id="afc3b043b782b88100272b556388b9e4d"></a>
constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#afc3b043b782b88100272b556388b9e4d">path_view</a> (const char *v, size_t len) noexcept</td></tr>
<tr class="memdesc:afc3b043b782b88100272b556388b9e4d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a UTF-8 path view from a lengthed <code>const char *</code>. The input string MUST continue to exist for this view to be valid. <br /></td></tr>
<tr class="separator:afc3b043b782b88100272b556388b9e4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82487e2de3c0b23cb237de064b71f072"><td class="memItemLeft" align="right" valign="top">constexpr </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a82487e2de3c0b23cb237de064b71f072">path_view</a> (string_view v) noexcept</td></tr>
<tr class="separator:a82487e2de3c0b23cb237de064b71f072"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83b86163124a03eadb509e3bb4bcce3e"><td class="memItemLeft" align="right" valign="top"><a id="a83b86163124a03eadb509e3bb4bcce3e"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a83b86163124a03eadb509e3bb4bcce3e">path_view</a> (const <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> &)=default</td></tr>
<tr class="memdesc:a83b86163124a03eadb509e3bb4bcce3e"><td class="mdescLeft"> </td><td class="mdescRight">Default copy constructor. <br /></td></tr>
<tr class="separator:a83b86163124a03eadb509e3bb4bcce3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4fb290145d390bd9e8cf3b5e2553c266"><td class="memItemLeft" align="right" valign="top"><a id="a4fb290145d390bd9e8cf3b5e2553c266"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a4fb290145d390bd9e8cf3b5e2553c266">path_view</a> (<a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> &&o) noexcept=default</td></tr>
<tr class="memdesc:a4fb290145d390bd9e8cf3b5e2553c266"><td class="mdescLeft"> </td><td class="mdescRight">Default move constructor. <br /></td></tr>
<tr class="separator:a4fb290145d390bd9e8cf3b5e2553c266"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9c86fad629570418502318585ec9f2a"><td class="memItemLeft" align="right" valign="top"><a id="ad9c86fad629570418502318585ec9f2a"></a>
<a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ad9c86fad629570418502318585ec9f2a">operator=</a> (const <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> &p)=default</td></tr>
<tr class="memdesc:ad9c86fad629570418502318585ec9f2a"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment. <br /></td></tr>
<tr class="separator:ad9c86fad629570418502318585ec9f2a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3cfdc7d5b0557c4f5d1c7f7ca9b0a76f"><td class="memItemLeft" align="right" valign="top"><a id="a3cfdc7d5b0557c4f5d1c7f7ca9b0a76f"></a>
<a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a3cfdc7d5b0557c4f5d1c7f7ca9b0a76f">operator=</a> (<a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> &&p) noexcept=default</td></tr>
<tr class="memdesc:a3cfdc7d5b0557c4f5d1c7f7ca9b0a76f"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment. <br /></td></tr>
<tr class="separator:a3cfdc7d5b0557c4f5d1c7f7ca9b0a76f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7ae611a6aa7fed01b4447a3f5133c14"><td class="memItemLeft" align="right" valign="top"><a id="ab7ae611a6aa7fed01b4447a3f5133c14"></a>
constexpr void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ab7ae611a6aa7fed01b4447a3f5133c14">swap</a> (<a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> &o) noexcept</td></tr>
<tr class="memdesc:ab7ae611a6aa7fed01b4447a3f5133c14"><td class="mdescLeft"> </td><td class="mdescRight">Swap the view with another. <br /></td></tr>
<tr class="separator:ab7ae611a6aa7fed01b4447a3f5133c14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66974f27d78f7797647d516bcef5b972"><td class="memItemLeft" align="right" valign="top"><a id="a66974f27d78f7797647d516bcef5b972"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a66974f27d78f7797647d516bcef5b972">empty</a> () const noexcept</td></tr>
<tr class="memdesc:a66974f27d78f7797647d516bcef5b972"><td class="mdescLeft"> </td><td class="mdescRight">True if empty. <br /></td></tr>
<tr class="separator:a66974f27d78f7797647d516bcef5b972"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7471a7020096e4572c5e149ffd4183df"><td class="memItemLeft" align="right" valign="top"><a id="a7471a7020096e4572c5e149ffd4183df"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_root_path</b> () const noexcept</td></tr>
<tr class="separator:a7471a7020096e4572c5e149ffd4183df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acda14fc1742e589bd5ccef74f886f4e3"><td class="memItemLeft" align="right" valign="top"><a id="acda14fc1742e589bd5ccef74f886f4e3"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_root_name</b> () const noexcept</td></tr>
<tr class="separator:acda14fc1742e589bd5ccef74f886f4e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70e2849c73d9202e7da8d710819f4baf"><td class="memItemLeft" align="right" valign="top"><a id="a70e2849c73d9202e7da8d710819f4baf"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_root_directory</b> () const noexcept</td></tr>
<tr class="separator:a70e2849c73d9202e7da8d710819f4baf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d007ed67384836177b51e81787db45d"><td class="memItemLeft" align="right" valign="top"><a id="a3d007ed67384836177b51e81787db45d"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_relative_path</b> () const noexcept</td></tr>
<tr class="separator:a3d007ed67384836177b51e81787db45d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3015b99f2835aea736d8c82454f3f22e"><td class="memItemLeft" align="right" valign="top"><a id="a3015b99f2835aea736d8c82454f3f22e"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_parent_path</b> () const noexcept</td></tr>
<tr class="separator:a3015b99f2835aea736d8c82454f3f22e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26364e4bd77830b946bc49fac572e824"><td class="memItemLeft" align="right" valign="top"><a id="a26364e4bd77830b946bc49fac572e824"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_filename</b> () const noexcept</td></tr>
<tr class="separator:a26364e4bd77830b946bc49fac572e824"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99f95c3a84d115286785f594dc653651"><td class="memItemLeft" align="right" valign="top"><a id="a99f95c3a84d115286785f594dc653651"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_stem</b> () const noexcept</td></tr>
<tr class="separator:a99f95c3a84d115286785f594dc653651"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa38b76392e556027db43ebc24ac9638d"><td class="memItemLeft" align="right" valign="top"><a id="aa38b76392e556027db43ebc24ac9638d"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>has_extension</b> () const noexcept</td></tr>
<tr class="separator:aa38b76392e556027db43ebc24ac9638d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa764357828bed56ec356828a090aff86"><td class="memItemLeft" align="right" valign="top"><a id="aa764357828bed56ec356828a090aff86"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>is_absolute</b> () const noexcept</td></tr>
<tr class="separator:aa764357828bed56ec356828a090aff86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9532a152294cc91153584a909210b30"><td class="memItemLeft" align="right" valign="top"><a id="ae9532a152294cc91153584a909210b30"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>is_relative</b> () const noexcept</td></tr>
<tr class="separator:ae9532a152294cc91153584a909210b30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fca33ec3b70cbe44bc3c6968fdc6376"><td class="memItemLeft" align="right" valign="top"><a id="a9fca33ec3b70cbe44bc3c6968fdc6376"></a>
constexpr bool </td><td class="memItemRight" valign="bottom"><b>contains_glob</b> () const noexcept</td></tr>
<tr class="separator:a9fca33ec3b70cbe44bc3c6968fdc6376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae9a62aedb89084d33bc1d8705f097a9"><td class="memItemLeft" align="right" valign="top"><a id="aae9a62aedb89084d33bc1d8705f097a9"></a>
constexpr void </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#aae9a62aedb89084d33bc1d8705f097a9">remove_filename</a> () noexcept</td></tr>
<tr class="memdesc:aae9a62aedb89084d33bc1d8705f097a9"><td class="mdescLeft"> </td><td class="mdescRight">Adjusts the end of this view to match the final separator. <br /></td></tr>
<tr class="separator:aae9a62aedb89084d33bc1d8705f097a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2265f98040ccff9b1707326d4984ba4e"><td class="memItemLeft" align="right" valign="top"><a id="a2265f98040ccff9b1707326d4984ba4e"></a>
constexpr size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a2265f98040ccff9b1707326d4984ba4e">native_size</a> () const noexcept</td></tr>
<tr class="memdesc:a2265f98040ccff9b1707326d4984ba4e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the view in characters. <br /></td></tr>
<tr class="separator:a2265f98040ccff9b1707326d4984ba4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5efe04f8c9f7a74559a10e81e775de2c"><td class="memItemLeft" align="right" valign="top"><a id="a5efe04f8c9f7a74559a10e81e775de2c"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a5efe04f8c9f7a74559a10e81e775de2c">root_name</a> () const noexcept</td></tr>
<tr class="memdesc:a5efe04f8c9f7a74559a10e81e775de2c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of the root name part of this view e.g. C: <br /></td></tr>
<tr class="separator:a5efe04f8c9f7a74559a10e81e775de2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1ca707bbe218ba97647e6fc976ed0fc"><td class="memItemLeft" align="right" valign="top"><a id="af1ca707bbe218ba97647e6fc976ed0fc"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#af1ca707bbe218ba97647e6fc976ed0fc">root_directory</a> () const noexcept</td></tr>
<tr class="memdesc:af1ca707bbe218ba97647e6fc976ed0fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of the root directory, if there is one e.g. /. <br /></td></tr>
<tr class="separator:af1ca707bbe218ba97647e6fc976ed0fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace2d2fec2c49aff2a2536465b93e6639"><td class="memItemLeft" align="right" valign="top"><a id="ace2d2fec2c49aff2a2536465b93e6639"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ace2d2fec2c49aff2a2536465b93e6639">root_path</a> () const noexcept</td></tr>
<tr class="memdesc:ace2d2fec2c49aff2a2536465b93e6639"><td class="mdescLeft"> </td><td class="mdescRight">Returns, if any, a view of the root path part of this view e.g. C:/. <br /></td></tr>
<tr class="separator:ace2d2fec2c49aff2a2536465b93e6639"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2660a043095f236e04c64518befe3811"><td class="memItemLeft" align="right" valign="top"><a id="a2660a043095f236e04c64518befe3811"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a2660a043095f236e04c64518befe3811">relative_path</a> () const noexcept</td></tr>
<tr class="memdesc:a2660a043095f236e04c64518befe3811"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of everything after the root path. <br /></td></tr>
<tr class="separator:a2660a043095f236e04c64518befe3811"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a2538aaa8ee056c9e29eec1f4abc989"><td class="memItemLeft" align="right" valign="top"><a id="a0a2538aaa8ee056c9e29eec1f4abc989"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a0a2538aaa8ee056c9e29eec1f4abc989">parent_path</a> () const noexcept</td></tr>
<tr class="memdesc:a0a2538aaa8ee056c9e29eec1f4abc989"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of the everything apart from the filename part of this view. <br /></td></tr>
<tr class="separator:a0a2538aaa8ee056c9e29eec1f4abc989"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab9973b8929a55d92a74c8ef8a6f52f90"><td class="memItemLeft" align="right" valign="top"><a id="ab9973b8929a55d92a74c8ef8a6f52f90"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ab9973b8929a55d92a74c8ef8a6f52f90">filename</a> () const noexcept</td></tr>
<tr class="memdesc:ab9973b8929a55d92a74c8ef8a6f52f90"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of the filename part of this view. <br /></td></tr>
<tr class="separator:ab9973b8929a55d92a74c8ef8a6f52f90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4ea230ab9092e8accfcefbead546141"><td class="memItemLeft" align="right" valign="top"><a id="ad4ea230ab9092e8accfcefbead546141"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ad4ea230ab9092e8accfcefbead546141">stem</a> () const noexcept</td></tr>
<tr class="memdesc:ad4ea230ab9092e8accfcefbead546141"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of the filename without any file extension. <br /></td></tr>
<tr class="separator:ad4ea230ab9092e8accfcefbead546141"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8412be7f77b65810fd8da50987cdaf5a"><td class="memItemLeft" align="right" valign="top"><a id="a8412be7f77b65810fd8da50987cdaf5a"></a>
constexpr <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a8412be7f77b65810fd8da50987cdaf5a">extension</a> () const noexcept</td></tr>
<tr class="memdesc:a8412be7f77b65810fd8da50987cdaf5a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a view of the file extension part of this view. <br /></td></tr>
<tr class="separator:a8412be7f77b65810fd8da50987cdaf5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab86fa3a4456b6d298ec78e18e76f999d"><td class="memItemLeft" align="right" valign="top"><a id="ab86fa3a4456b6d298ec78e18e76f999d"></a>
filesystem::path </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#ab86fa3a4456b6d298ec78e18e76f999d">path</a> () const</td></tr>
<tr class="memdesc:ab86fa3a4456b6d298ec78e18e76f999d"><td class="mdescLeft"> </td><td class="mdescRight">Return the path view as a path. <br /></td></tr>
<tr class="separator:ab86fa3a4456b6d298ec78e18e76f999d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f19b4fa899ae090c7143946b4349dea"><td class="memItemLeft" align="right" valign="top">constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a0f19b4fa899ae090c7143946b4349dea">compare</a> (const <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> &p) const noexcept</td></tr>
<tr class="separator:a0f19b4fa899ae090c7143946b4349dea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c284ac9b48c76ad15d5371d4c8313eb"><td class="memItemLeft" align="right" valign="top">constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a1c284ac9b48c76ad15d5371d4c8313eb">compare</a> (const char *s) const noexcept</td></tr>
<tr class="separator:a1c284ac9b48c76ad15d5371d4c8313eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad3b3e087045c66f5580be26dbaedc64"><td class="memItemLeft" align="right" valign="top">constexpr int </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#aad3b3e087045c66f5580be26dbaedc64">compare</a> (string_view str) const noexcept</td></tr>
<tr class="separator:aad3b3e087045c66f5580be26dbaedc64"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a5d34d5bd6de76ad2d56817214a7b8aee"><td class="memItemLeft" align="right" valign="top"><a id="a5d34d5bd6de76ad2d56817214a7b8aee"></a>
static constexpr auto </td><td class="memItemRight" valign="bottom"><a class="el" href="classllfio__v2__xxx_1_1path__view.html#a5d34d5bd6de76ad2d56817214a7b8aee">preferred_separator</a> = filesystem::path::preferred_separator</td></tr>
<tr class="memdesc:a5d34d5bd6de76ad2d56817214a7b8aee"><td class="mdescLeft"> </td><td class="mdescRight">The preferred separator type. <br /></td></tr>
<tr class="separator:a5d34d5bd6de76ad2d56817214a7b8aee"><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:a28161b36656c08a0ea8759fe79234547"><td class="memItemLeft" align="right" valign="top"><a id="a28161b36656c08a0ea8759fe79234547"></a>
struct </td><td class="memItemRight" valign="bottom"><b>c_str</b></td></tr>
<tr class="separator:a28161b36656c08a0ea8759fe79234547"><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 borrowed view of a path. A lightweight trivial-type alternative to <code>std::filesystem::path</code>. </p>
<p>LLFIO is sufficiently fast that <code>std::filesystem::path</code> as a wrapper of an underlying <code>std::basic_string<></code> can be problematically expensive for some filing system operations due to the potential memory allocation. LLFIO therefore works exclusively with borrowed views of other path storage.</p>
<p>Some of the API for <code>std::filesystem::path</code> is replicated here, however any APIs which modify the path other than taking subsets are obviously not possible with borrowed views.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Lots of member functions remain to be implemented.</dd></dl>
<h1>Windows specific notes:</h1>
<p>Be aware that on Microsoft Windows, the native path storage <code>std::filesystem::path::value_type</code> is a <code>wchar_t</code> referring to UTF-16. However much of LLFIO path usage is a <code>path_handle</code> to somewhere on the filing system plus a relative <code>const char *</code> UTF-8 path fragment as the use of absolute paths is discouraged. Rather than complicate the ABI to handle templated path character types, on Microsoft Windows only we do the following:</p>
<ul>
<li>If view input is <code>wchar_t</code>, the original source is passed through unmodified to the syscall without any memory allocation, copying nor slash conversion.</li>
<li>If view input is <code>char</code>:<ol type="1">
<li>The original source <b>is assumed to be in UTF-8</b>, not ASCII like most <code>char</code> paths on Microsoft Windows.</li>
<li>Use with any kernel function converts to a temporary UTF-16 internal buffer. We use the fast NT kernel UTF8 to UTF16 routine, not the slow Win32 routine.</li>
<li>Any forward slashes are converted to backwards slashes.</li>
</ol>
</li>
</ul>
<p>LLFIO calls the NT kernel API directly rather than the Win32 API for:</p>
<ul>
<li>For any paths relative to a <code>path_handle</code> (the Win32 API does not provide a race free file system API).</li>
<li>For any paths beginning with <code>\!!\</code>, we pass the path + 3 characters directly through. This prefix is a pure LLFIO extension, and will not be recognised by other code.</li>
<li>For any paths beginning with <code>\??\</code>, we pass the path + 0 characters directly through. Note the NT kernel keeps a symlink at <code>\??\</code> which refers to the DosDevices namespace for the current login, so as an incorrect relation which you should <b>not</b> rely on, the Win32 path <code>C:\foo</code> probably will appear at <code>\??\C:\foo</code>.</li>
</ul>
<p>These prefixes are still passed to the Win32 API:</p>
<ul>
<li><code>\\?\</code> which is used to tell a Win32 API that the remaining path is longer than a DOS path.</li>
<li><code>\\.\</code> which since Windows 7 is treated exactly like <code>\\?\</code>.</li>
</ul>
<p>If the NT kernel API is used directly then:</p>
<ul>
<li>Paths are matched case sensitively as raw bytes via <code>memcmp()</code>, not case insensitively (requires slow locale conversion).</li>
<li>The path limit is 32,767 characters.</li>
</ul>
<p>If you really care about performance, you are very strongly recommended to use the NT kernel API wherever possible. Where paths are involved, it is often three to five times faster due to the multiple memory allocations and string translations that the Win32 functions perform before calling the NT kernel routine.</p>
<p>If however you are taking input from some external piece of code, then for maximum compatibility you should still use the Win32 API. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a82487e2de3c0b23cb237de064b71f072"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82487e2de3c0b23cb237de064b71f072">◆ </a></span>path_view()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr llfio_v2_xxx::path_view::path_view </td>
<td>(</td>
<td class="paramtype">string_view </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implicitly constructs a UTF-8 path view from a string view. </p><dl class="section warning"><dt>Warning</dt><dd>The byte after the end of the view must be legal to read. </dd></dl>
<div class="fragment"><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> : _state(v) {} <span class="comment">// NOLINT</span></div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0f19b4fa899ae090c7143946b4349dea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f19b4fa899ae090c7143946b4349dea">◆ </a></span>compare() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr int llfio_v2_xxx::path_view::compare </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</a> & </td>
<td class="paramname"><em>p</em></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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares the two string views via the view's <code>compare()</code> which in turn calls <code>traits::compare()</code>. Be aware that on Windows a conversion from UTF-8 to UTF-16 is performed if needed. </p>
<div class="fragment"><div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  {</div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="keywordflow">return</span> _invoke([&p](<span class="keyword">const</span> <span class="keyword">auto</span> &v) { <span class="keywordflow">return</span> -p.compare(v); });</div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  }</div></div><!-- fragment -->
</div>
</div>
<a id="a1c284ac9b48c76ad15d5371d4c8313eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c284ac9b48c76ad15d5371d4c8313eb">◆ </a></span>compare() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr int llfio_v2_xxx::path_view::compare </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>s</em></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> </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="l00543"></a><span class="lineno"> 543</span>  {</div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  <span class="keywordflow">return</span> <a class="code" href="classllfio__v2__xxx_1_1path__view.html#a0f19b4fa899ae090c7143946b4349dea">compare</a>(string_view(s));</div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  }</div><div class="ttc" id="classllfio__v2__xxx_1_1path__view_html_a0f19b4fa899ae090c7143946b4349dea"><div class="ttname"><a href="classllfio__v2__xxx_1_1path__view.html#a0f19b4fa899ae090c7143946b4349dea">llfio_v2_xxx::path_view::compare</a></div><div class="ttdeci">constexpr int compare(const path_view &p) const noexcept</div><div class="ttdef"><b>Definition:</b> path_view.hpp:534</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="aad3b3e087045c66f5580be26dbaedc64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad3b3e087045c66f5580be26dbaedc64">◆ </a></span>compare() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr int llfio_v2_xxx::path_view::compare </td>
<td>(</td>
<td class="paramtype">string_view </td>
<td class="paramname"><em>str</em></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> </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="l00551"></a><span class="lineno"> 551</span>  {</div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="preprocessor">#ifdef _WIN32</span></div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keywordflow">if</span>(!_state._utf16.empty())</div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  {</div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  c_str z(<a class="code" href="classllfio__v2__xxx_1_1path__view.html#a91540ade852194b9507184cdcaed3339">path_view</a>(str), <span class="keyword">false</span>);</div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  <span class="keywordflow">return</span> _state._utf16.compare(wstring_view(z.buffer, z.length));</div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span>  }</div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span>  <span class="keywordflow">return</span> _state._utf8.compare(str);</div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span>  }</div><div class="ttc" id="classllfio__v2__xxx_1_1path__view_html_a91540ade852194b9507184cdcaed3339"><div class="ttname"><a href="classllfio__v2__xxx_1_1path__view.html#a91540ade852194b9507184cdcaed3339">llfio_v2_xxx::path_view::path_view</a></div><div class="ttdeci">constexpr path_view()</div><div class="ttdoc">Constructs an empty path view. </div><div class="ttdef"><b>Definition:</b> path_view.hpp:202</div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/llfio/v2.0/<a class="el" href="path__view_8hpp.html">path_view.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacellfio__v2__xxx.html">llfio_v2_xxx</a></li><li class="navelem"><a class="el" href="classllfio__v2__xxx_1_1path__view.html">path_view</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>
|
