From Jason Turner

[fs.enum]

Diff to HTML by rtfpessoa

Files changed (1) hide show
  1. tmp/tmpm32fbvc6/{from.md → to.md} +29 -10
tmp/tmpm32fbvc6/{from.md → to.md} RENAMED
@@ -3,22 +3,41 @@
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
@@ -29,16 +48,16 @@ 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. |
37
  | `overwrite_existing` | Overwrite the existing file. |
38
- | `update_existing` | Overwrite the existing file if it is older than the replacement file. \ohdrx{2}{Option group controlling `copy` function effects for sub-directories} |
39
- | `recursive` | Recursively copy sub-directories and their contents. \ohdrx{2}{Option group controlling `copy` function effects for symbolic links} |
40
  | `copy_symlinks` | Copy symbolic links as symbolic links rather than copying the files that they point to. |
41
  | `skip_symlinks` | Ignore symbolic links. \ohdrx{2}{Option group controlling `copy` function effects for choosing the form of copying} |
42
  | `directories_only` | Copy directory structure only, do not copy non-directory files. |
43
  | `create_symlinks` | Make symbolic links instead of copies of files. The source path shall be an absolute path unless the destination path is in the current directory. |
44
  | `create_hard_links` | Make hard links instead of copies of files. |
@@ -87,12 +106,12 @@ permissions operations, with the meanings listed in
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
 
 
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
+ **Table: Enum `path::format`** <a id="fs.enum.path.format">[fs.enum.path.format]</a>
9
+
10
+ | Name | Meaning |
11
+ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12
+ | `native_format` | The native pathname format. |
13
+ | `generic_format` | The generic pathname format. |
14
+ | `auto_format` | The interpretation of the format of the character sequence is implementation-defined. The implementation may inspect the content of the character sequence to determine the format. Recommended practice: For POSIX-based systems, native and generic formats are equivalent and the character sequence should always be interpreted in the same way. |
15
+
16
 
17
  #### Enum class `file_type` <a id="fs.enum.file.type">[[fs.enum.file.type]]</a>
18
 
19
  This enum class specifies constants used to identify file types, with
20
  the meanings listed in [[fs.enum.file.type]]. The values of the
21
  constants are distinct.
22
 
23
+ **Table: Enum class `file_type`** <a id="fs.enum.file.type">[fs.enum.file.type]</a>
24
+
25
+ | Constant | Meaning |
26
+ | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
+ | `none` | The type of the file has not been determined or an error occurred while trying to determine the type. |
28
+ | `not_found` | Pseudo-type indicating the file was not found. *The file not being found is not considered an error while determining the type of a file.* |
29
+ | `regular` | Regular file |
30
+ | `directory` | Directory file |
31
+ | `symlink` | Symbolic link file |
32
+ | `block` | Block special file |
33
+ | `character` | Character special file |
34
+ | `fifo` | FIFO or pipe file |
35
+ | `socket` | Socket file |
36
+ | `implementation-defined` | Implementations that support file systems having file types in addition to the above `file_type` types shall supply implementation-defined `file_type` constants to separately identify each of those additional file types |
37
+ | `unknown` | The file exists but the type cannot be determined |
38
+
39
 
40
  #### Enum class `copy_options` <a id="fs.enum.copy.opts">[[fs.enum.copy.opts]]</a>
41
 
42
  The `enum class` type `copy_options` is a bitmask type [[bitmask.types]]
43
  that specifies bitmask constants used to control the semantics of copy
 
48
  Every other constant in the table represents a distinct bitmask element.
49
 
50
  **Table: Enum class `copy_options`** <a id="fs.enum.copy.opts">[fs.enum.copy.opts]</a>
51
 
52
  | Constant | Meaning |
53
+ | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
54
  | `none` | (Default) Error; file already exists. |
55
  | `skip_existing` | Do not overwrite existing file, do not report an error. |
56
  | `overwrite_existing` | Overwrite the existing file. |
57
+ | `update_existing` | Overwrite the existing file if it is older than the replacement file. \ohdrx{2}{Option group controlling `copy` function effects for subdirectories} |
58
+ | `recursive` | Recursively copy subdirectories and their contents. \ohdrx{2}{Option group controlling `copy` function effects for symbolic links} |
59
  | `copy_symlinks` | Copy symbolic links as symbolic links rather than copying the files that they point to. |
60
  | `skip_symlinks` | Ignore symbolic links. \ohdrx{2}{Option group controlling `copy` function effects for choosing the form of copying} |
61
  | `directories_only` | Copy directory structure only, do not copy non-directory files. |
62
  | `create_symlinks` | Make symbolic links instead of copies of files. The source path shall be an absolute path unless the destination path is in the current directory. |
63
  | `create_hard_links` | Make hard links instead of copies of files. |
 
106
  **Table: Enum class `perm_options`** <a id="fs.enum.perm.opts">[fs.enum.perm.opts]</a>
107
 
108
  | Name | Meaning |
109
  | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
110
  | `replace` | `permissions` shall replace the file's permission bits with `perm` |
111
+ | `add` | `permissions` shall replace the file's permission bits with the bitwise \logop{or} of `perm` and the file's current permission bits. |
112
+ | `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. |
113
  | `nofollow` | `permissions` shall change the permissions of a symbolic link itself rather than the permissions of the file the link resolves to. |
114
 
115
 
116
  #### Enum class `directory_options` <a id="fs.enum.dir.opts">[[fs.enum.dir.opts]]</a>
117