From Jason Turner

[fs.enum]

C++17 → C++20 8.5 KB 65 lines
Current Draft | LaTeX Source
Archived: C++17 | C++20
Markdown: C++17 | C++20
Explore in Adventure Game

Diff to HTML by rtfpessoa

Files changed (1) hide show
  1. tmp/tmp1o0cj2x9/{from.md → to.md} +31 -29
tmp/tmp1o0cj2x9/{from.md → to.md} RENAMED
@@ -1,35 +1,36 @@
1
  ### Enumerations <a id="fs.enum">[[fs.enum]]</a>
2
 
3
  #### Enum `path::format` <a id="fs.enum.path.format">[[fs.enum.path.format]]</a>
4
 
5
  This enum specifies constants used to identify the format of the
6
- character sequence, with the meanings listed in Table 
7
- [[tab:enum.path.format]].
8
 
9
  [*Note 1*: For POSIX-based systems, native and generic formats are
10
  equivalent and the character sequence should always be interpreted in
11
  the same way. — *end note*]
12
 
13
- #### Enum class `file_type` <a id="fs.enum.file_type">[[fs.enum.file_type]]</a>
14
 
15
  This enum class specifies constants used to identify file types, with
16
- the meanings listed in Table  [[tab:fs.enum.file_type]].
 
17
 
18
  [*Note 1*: The file not being found is not considered an error while
19
  determining the type of a file. — *end note*]
20
 
21
  #### Enum class `copy_options` <a id="fs.enum.copy.opts">[[fs.enum.copy.opts]]</a>
22
 
23
- The `enum class` type `copy_options` is a bitmask type (
24
- [[bitmask.types]]) that specifies bitmask constants used to control the
25
- semantics of copy operations. The constants are specified in option
26
- groups with the meanings listed in Table  [[tab:fs.enum.copy_options]].
27
- Constant `none` is shown in each option group for purposes of
28
  exposition; implementations shall provide only a single definition.
 
29
 
30
- **Table: Enum class `copy_options`** <a id="tab:fs.enum.copy_options">[tab:fs.enum.copy_options]</a>
31
 
32
  | Constant | Meaning |
33
  | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
34
  | `none` | (Default) Error; file already exists. |
35
  | `skip_existing` | Do not overwrite existing file, do not report an error. |
@@ -43,15 +44,15 @@ exposition; implementations shall provide only a single definition.
43
  | `create_hard_links` | Make hard links instead of copies of files. |
44
 
45
 
46
  #### Enum class `perms` <a id="fs.enum.perms">[[fs.enum.perms]]</a>
47
 
48
- The `enum class` type `perms` is a bitmask type ([[bitmask.types]])
49
- that specifies bitmask constants used to identify file permissions, with
50
- the meanings listed in Table  [[tab:fs.enum.perms]].
51
 
52
- **Table: Enum class `perms`** <a id="tab:fs.enum.perms">[tab:fs.enum.perms]</a>
53
 
54
  | Name | Value (octal) | POSIX macro | Definition or notes |
55
  | -------------- | ------------- | ----------- | ---------------------------------------------------------------------------------------------------------------- |
56
  | `none` | `0` | | There are no permissions set for the file. |
57
  | `owner_read` | `0400` | `S_IRUSR` | Read permission, owner |
@@ -74,35 +75,36 @@ the meanings listed in Table  [[tab:fs.enum.perms]].
74
  | `unknown` | `0xFFFF` | | The permissions are not known, such as when a `file_status` object is created without specifying the permissions |
75
 
76
 
77
  #### Enum class `perm_options` <a id="fs.enum.perm.opts">[[fs.enum.perm.opts]]</a>
78
 
79
- The `enum class` type `perm_options` is a bitmask type (
80
- [[bitmask.types]]) that specifies bitmask constants used to control the
81
- semantics of permissions operations, with the meanings listed in Table 
82
- [[tab:enum.perm_options]]. The bitmask constants are bitmask elements.
83
- In Table  [[tab:enum.perm_options]] `perm` denotes a value of type
84
- `perms` passed to `permissions`.
85
 
86
- **Table: Enum class `perm_options`** <a id="tab:enum.perm_options">[tab:enum.perm_options]</a>
87
 
88
  | Name | Meaning |
89
- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
90
  | `replace` | `permissions` shall replace the file's permission bits with `perm` |
91
- | `add` | `permissions` shall replace the file's permission bits with the bitwise OR of `perm` and the file's current permission bits. |
92
- | `remove` | `permissions` shall replace the file's permission bits with the bitwise AND of the complement of `perm` and the file's current permission bits. |
93
  | `nofollow` | `permissions` shall change the permissions of a symbolic link itself rather than the permissions of the file the link resolves to. |
94
 
95
 
96
  #### Enum class `directory_options` <a id="fs.enum.dir.opts">[[fs.enum.dir.opts]]</a>
97
 
98
- The `enum class` type `directory_options` is a bitmask type (
99
- [[bitmask.types]]) that specifies bitmask constants used to identify
100
- directory traversal options, with the meanings listed in Table 
101
- [[tab:fs.enum.directory_options]].
 
102
 
103
- **Table: Enum class `directory_options`** <a id="tab:fs.enum.directory_options">[tab:fs.enum.directory_options]</a>
104
 
105
  | Name | Meaning |
106
  | -------------------------- | ------------------------------------------------------------------ |
107
  | `none` | (Default) Skip directory symlinks, permission denied is an error. |
108
  | `follow_directory_symlink` | Follow rather than skip directory symlinks. |
 
1
  ### Enumerations <a id="fs.enum">[[fs.enum]]</a>
2
 
3
  #### Enum `path::format` <a id="fs.enum.path.format">[[fs.enum.path.format]]</a>
4
 
5
  This enum specifies constants used to identify the format of the
6
+ character sequence, with the meanings listed in [[fs.enum.path.format]].
 
7
 
8
  [*Note 1*: For POSIX-based systems, native and generic formats are
9
  equivalent and the character sequence should always be interpreted in
10
  the same way. — *end note*]
11
 
12
+ #### Enum class `file_type` <a id="fs.enum.file.type">[[fs.enum.file.type]]</a>
13
 
14
  This enum class specifies constants used to identify file types, with
15
+ the meanings listed in [[fs.enum.file.type]]. The values of the
16
+ constants are distinct.
17
 
18
  [*Note 1*: The file not being found is not considered an error while
19
  determining the type of a file. — *end note*]
20
 
21
  #### Enum class `copy_options` <a id="fs.enum.copy.opts">[[fs.enum.copy.opts]]</a>
22
 
23
+ The `enum class` type `copy_options` is a bitmask type [[bitmask.types]]
24
+ that specifies bitmask constants used to control the semantics of copy
25
+ operations. The constants are specified in option groups with the
26
+ meanings listed in [[fs.enum.copy.opts]]. The constant `none` represents
27
+ the empty bitmask, and is shown in each option group for purposes of
28
  exposition; implementations shall provide only a single definition.
29
+ Every other constant in the table represents a distinct bitmask element.
30
 
31
+ **Table: Enum class `copy_options`** <a id="fs.enum.copy.opts">[fs.enum.copy.opts]</a>
32
 
33
  | Constant | Meaning |
34
  | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
35
  | `none` | (Default) Error; file already exists. |
36
  | `skip_existing` | Do not overwrite existing file, do not report an error. |
 
44
  | `create_hard_links` | Make hard links instead of copies of files. |
45
 
46
 
47
  #### Enum class `perms` <a id="fs.enum.perms">[[fs.enum.perms]]</a>
48
 
49
+ The `enum class` type `perms` is a bitmask type [[bitmask.types]] that
50
+ specifies bitmask constants used to identify file permissions, with the
51
+ meanings listed in [[fs.enum.perms]].
52
 
53
+ **Table: Enum class `perms`** <a id="fs.enum.perms">[fs.enum.perms]</a>
54
 
55
  | Name | Value (octal) | POSIX macro | Definition or notes |
56
  | -------------- | ------------- | ----------- | ---------------------------------------------------------------------------------------------------------------- |
57
  | `none` | `0` | | There are no permissions set for the file. |
58
  | `owner_read` | `0400` | `S_IRUSR` | Read permission, owner |
 
75
  | `unknown` | `0xFFFF` | | The permissions are not known, such as when a `file_status` object is created without specifying the permissions |
76
 
77
 
78
  #### Enum class `perm_options` <a id="fs.enum.perm.opts">[[fs.enum.perm.opts]]</a>
79
 
80
+ The `enum class` type `perm_options` is a bitmask type [[bitmask.types]]
81
+ that specifies bitmask constants used to control the semantics of
82
+ permissions operations, with the meanings listed in
83
+ [[fs.enum.perm.opts]]. The bitmask constants are bitmask elements. In
84
+ [[fs.enum.perm.opts]] `perm` denotes a value of type `perms` passed to
85
+ `permissions`.
86
 
87
+ **Table: Enum class `perm_options`** <a id="fs.enum.perm.opts">[fs.enum.perm.opts]</a>
88
 
89
  | Name | Meaning |
90
+ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
91
  | `replace` | `permissions` shall replace the file's permission bits with `perm` |
92
+ | `add` | `permissions` shall replace the file's permission bits with the bitwise \logop{OR} of `perm` and the file's current permission bits. |
93
+ | `remove` | `permissions` shall replace the file's permission bits with the bitwise \logop{AND} of the complement of `perm` and the file's current permission bits. |
94
  | `nofollow` | `permissions` shall change the permissions of a symbolic link itself rather than the permissions of the file the link resolves to. |
95
 
96
 
97
  #### Enum class `directory_options` <a id="fs.enum.dir.opts">[[fs.enum.dir.opts]]</a>
98
 
99
+ The `enum class` type `directory_options` is a bitmask type
100
+ [[bitmask.types]] that specifies bitmask constants used to identify
101
+ directory traversal options, with the meanings listed in
102
+ [[fs.enum.dir.opts]]. The constant `none` represents the empty bitmask;
103
+ every other constant in the table represents a distinct bitmask element.
104
 
105
+ **Table: Enum class `directory_options`** <a id="fs.enum.dir.opts">[fs.enum.dir.opts]</a>
106
 
107
  | Name | Meaning |
108
  | -------------------------- | ------------------------------------------------------------------ |
109
  | `none` | (Default) Skip directory symlinks, permission denied is an error. |
110
  | `follow_directory_symlink` | Follow rather than skip directory symlinks. |