diff options
| author | Marshall Lochbaum <mwlochbaum@gmail.com> | 2022-04-09 15:59:45 -0400 |
|---|---|---|
| committer | Marshall Lochbaum <mwlochbaum@gmail.com> | 2022-04-09 15:59:45 -0400 |
| commit | a7e38bd0e8a7b25f8d6ae8f5069e931026a7d8e7 (patch) | |
| tree | 756c651d050204fd980e23b8dfccf700ae55770b /docs | |
| parent | 9bdaee77985cea538416c312f49a1653a40db6e1 (diff) | |
•file.MapBytes specification
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/spec/system.html | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/spec/system.html b/docs/spec/system.html index 17159837..7469fa06 100644 --- a/docs/spec/system.html +++ b/docs/spec/system.html @@ -254,6 +254,10 @@ <td><code><span class='Function'>Bytes</span></code></td> <td>Read from or write to entire file, as bytes</td> </tr> +<tr> +<td><code><span class='Function'>MapBytes</span></code></td> +<td>Create a memory-mapped array aliasing the file</td> +</tr> </tbody> </table> <p><code><span class='Function'>Rename</span></code>, <code><span class='Function'>Copy</span></code>, and <code><span class='Function'>CreateDir</span></code> return the path of the new file. <code><span class='Function'>Remove</span></code> and <code><span class='Function'>RemoveDir</span></code> return <code><span class='Number'>1</span></code> to indicate successful removal (and error otherwise).</p> @@ -264,6 +268,7 @@ <li>Lines: BQN strings. The file is decoded as with chars, then split into lines by CR, LR, or CRLF line endings.</li> <li>Bytes: Single-byte values, stored as BQN characters from <code><span class='String'>@</span></code> to <code><span class='String'>@</span><span class='Function'>+</span><span class='Number'>255</span></code>.</li> </ul> +<p>The <code><span class='Function'>MapBytes</span></code> function only takes one argument, a filename, and returns an array matching the result of <code><span class='Function'>Bytes</span></code>. However, the array data should be <a href="https://en.wikipedia.org/wiki/Memory-mapped_file">memory-mapped</a> allowing it to be loaded into memory on use. The array and arrays derived from it (such as slices) may change in value if the underlying file is modified after <code><span class='Function'>MapBytes</span></code> is called.</p> <p>The following short names can also be provided for file access. They can be provided, and use the definitions from above even if <code><span class='Value'>•file</span></code> is not provided.</p> <table> <thead> @@ -288,6 +293,7 @@ </tbody> </table> <h3 id="open-file-object"><a class="header" href="#open-file-object">Open file object</a></h3> +<p>Not yet specified.</p> <h2 id="input-and-output"><a class="header" href="#input-and-output">Input and output</a></h2> <table> <thead> |