From Jason Turner

[fs.dir.entry.obs]

Diff to HTML by rtfpessoa

Files changed (1) hide show
  1. tmp/tmp3x3yf6mp/{from.md → to.md} +191 -0
tmp/tmp3x3yf6mp/{from.md → to.md} RENAMED
@@ -0,0 +1,191 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ #### `directory_entry` observers <a id="fs.dir.entry.obs">[[fs.dir.entry.obs]]</a>
2
+
3
+ Unqualified function names in the *Returns:* elements of the
4
+ `directory_entry` observers described below refer to members of the
5
+ `std::filesystem` namespace.
6
+
7
+ ``` cpp
8
+ const path& path() const noexcept;
9
+ operator const path&() const noexcept;
10
+ ```
11
+
12
+ *Returns:* `pathobject`.
13
+
14
+ ``` cpp
15
+ bool exists() const;
16
+ bool exists(error_code& ec) const noexcept;
17
+ ```
18
+
19
+ *Returns:* `exists(this->status())` or `exists(this->status(), ec)`,
20
+ respectively.
21
+
22
+ *Throws:* As specified in  [[fs.err.report]].
23
+
24
+ ``` cpp
25
+ bool is_block_file() const;
26
+ bool is_block_file(error_code& ec) const noexcept;
27
+ ```
28
+
29
+ *Returns:* `is_block_file(this->status())` or
30
+ `is_block_file(this->status(), ec)`, respectively.
31
+
32
+ *Throws:* As specified in  [[fs.err.report]].
33
+
34
+ ``` cpp
35
+ bool is_character_file() const;
36
+ bool is_character_file(error_code& ec) const noexcept;
37
+ ```
38
+
39
+ *Returns:* `is_character_file(this->status())` or
40
+ `is_character_file(this->status(), ec)`, respectively.
41
+
42
+ *Throws:* As specified in  [[fs.err.report]].
43
+
44
+ ``` cpp
45
+ bool is_directory() const;
46
+ bool is_directory(error_code& ec) const noexcept;
47
+ ```
48
+
49
+ *Returns:* `is_directory(this->status())` or
50
+ `is_directory(this->status(), ec)`, respectively.
51
+
52
+ *Throws:* As specified in  [[fs.err.report]].
53
+
54
+ ``` cpp
55
+ bool is_fifo() const;
56
+ bool is_fifo(error_code& ec) const noexcept;
57
+ ```
58
+
59
+ *Returns:* `is_fifo(this->status())` or `is_fifo(this->status(), ec)`,
60
+ respectively.
61
+
62
+ *Throws:* As specified in  [[fs.err.report]].
63
+
64
+ ``` cpp
65
+ bool is_other() const;
66
+ bool is_other(error_code& ec) const noexcept;
67
+ ```
68
+
69
+ *Returns:* `is_other(this->status())` or `is_other(this->status(), ec)`,
70
+ respectively.
71
+
72
+ *Throws:* As specified in  [[fs.err.report]].
73
+
74
+ ``` cpp
75
+ bool is_regular_file() const;
76
+ bool is_regular_file(error_code& ec) const noexcept;
77
+ ```
78
+
79
+ *Returns:* `is_regular_file(this->status())` or
80
+ `is_regular_file(this->status(), ec)`, respectively.
81
+
82
+ *Throws:* As specified in  [[fs.err.report]].
83
+
84
+ ``` cpp
85
+ bool is_socket() const;
86
+ bool is_socket(error_code& ec) const noexcept;
87
+ ```
88
+
89
+ *Returns:* `is_socket(this->status())` or
90
+ `is_socket(this->status(), ec)`, respectively.
91
+
92
+ *Throws:* As specified in  [[fs.err.report]].
93
+
94
+ ``` cpp
95
+ bool is_symlink() const;
96
+ bool is_symlink(error_code& ec) const noexcept;
97
+ ```
98
+
99
+ *Returns:* `is_symlink(this->symlink_status())` or
100
+ `is_symlink(this->symlink_status(), ec)`, respectively.
101
+
102
+ *Throws:* As specified in  [[fs.err.report]].
103
+
104
+ ``` cpp
105
+ uintmax_t file_size() const;
106
+ uintmax_t file_size(error_code& ec) const noexcept;
107
+ ```
108
+
109
+ *Returns:* If cached, the file size attribute value. Otherwise,
110
+ `file_size(path())` or `file_size(path(), ec)`, respectively.
111
+
112
+ *Throws:* As specified in  [[fs.err.report]].
113
+
114
+ ``` cpp
115
+ uintmax_t hard_link_count() const;
116
+ uintmax_t hard_link_count(error_code& ec) const noexcept;
117
+ ```
118
+
119
+ *Returns:* If cached, the hard link count attribute value. Otherwise,
120
+ `hard_link_count(path())` or `hard_link_count(path(), ec)`,
121
+ respectively.
122
+
123
+ *Throws:* As specified in  [[fs.err.report]].
124
+
125
+ ``` cpp
126
+ file_time_type last_write_time() const;
127
+ file_time_type last_write_time(error_code& ec) const noexcept;
128
+ ```
129
+
130
+ *Returns:* If cached, the last write time attribute value. Otherwise,
131
+ `last_write_time(path())` or `last_write_time(path(), ec)`,
132
+ respectively.
133
+
134
+ *Throws:* As specified in  [[fs.err.report]].
135
+
136
+ ``` cpp
137
+ file_status status() const;
138
+ file_status status(error_code& ec) const noexcept;
139
+ ```
140
+
141
+ *Returns:* If cached, the status attribute value. Otherwise,
142
+ `status(path())` or `status(path(), ec)`, respectively.
143
+
144
+ *Throws:* As specified in  [[fs.err.report]].
145
+
146
+ ``` cpp
147
+ file_status symlink_status() const;
148
+ file_status symlink_status(error_code& ec) const noexcept;
149
+ ```
150
+
151
+ *Returns:* If cached, the symlink status attribute value. Otherwise,
152
+ `symlink_status(path())` or `symlink_status(path(), ec)`, respectively.
153
+
154
+ *Throws:* As specified in  [[fs.err.report]].
155
+
156
+ ``` cpp
157
+ bool operator==(const directory_entry& rhs) const noexcept;
158
+ ```
159
+
160
+ *Returns:* `pathobject == rhs.pathobject`.
161
+
162
+ ``` cpp
163
+ bool operator!=(const directory_entry& rhs) const noexcept;
164
+ ```
165
+
166
+ *Returns:* `pathobject != rhs.pathobject`.
167
+
168
+ ``` cpp
169
+ bool operator< (const directory_entry& rhs) const noexcept;
170
+ ```
171
+
172
+ *Returns:* `pathobject < rhs.pathobject`.
173
+
174
+ ``` cpp
175
+ bool operator<=(const directory_entry& rhs) const noexcept;
176
+ ```
177
+
178
+ *Returns:* `pathobject <= rhs.pathobject`.
179
+
180
+ ``` cpp
181
+ bool operator> (const directory_entry& rhs) const noexcept;
182
+ ```
183
+
184
+ *Returns:* `pathobject > rhs.pathobject`.
185
+
186
+ ``` cpp
187
+ bool operator>=(const directory_entry& rhs) const noexcept;
188
+ ```
189
+
190
+ *Returns:* `pathobject >= rhs.pathobject`.
191
+