From 6610fa4b2afcfcc09175a84a006834d264f5b51d Mon Sep 17 00:00:00 2001 From: fubark Date: Fri, 8 Dec 2023 18:07:51 -0500 Subject: [PATCH] Regen docs. --- docs/hugo/content/docs/toc/modules.md | 68 +++++++++++++-------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/hugo/content/docs/toc/modules.md b/docs/hugo/content/docs/toc/modules.md index 3375f3ffe..2bf863fea 100644 --- a/docs/hugo/content/docs/toc/modules.md +++ b/docs/hugo/content/docs/toc/modules.md @@ -114,7 +114,7 @@ print typeof('my str').id() {{}}Copies a primitive value or creates a shallow copy of an object value.{{}} {{}}Prints the result of `toCyon` on a value.{{}} {{}}{{}} -{{}}Returns the current reference count of an object.{{}} +{{}}Returns the current reference count of an object.{{}} {{}}Returns whether two values refer to the same instance.{{}} {{}}Returns whether a rune is an alphabetic letter.{{}} {{}}Returns whether a rune is a digit.{{}} @@ -133,7 +133,7 @@ print typeof('my str').id() {{}}Converts a value to either `true` or `false`.{{}} ### `type error` -{{}}Return the underlying `symbol`.{{}} +{{}}Return the underlying `symbol`.{{}} {{}}Create an error from an enum or symbol.{{}} ### `type int` @@ -154,8 +154,8 @@ print typeof('my str').id() {{}}{{}} {{}}{{}} {{>(o any) int">}}{{}} -{{}}Formats the integer using a kind specifier which can be binary `.b`, octal `.o`, decimal `.d`, hexadecimal `.x`, ASCII `.c`.{{}} -{{}}`opts.pad` provides the ASCII rune that is used for padding with a string length of `opts.width`.{{}} +{{}}Formats the integer using a kind specifier which can be binary `.b`, octal `.o`, decimal `.d`, hexadecimal `.x`, ASCII `.c`.{{}} +{{}}`opts.pad` provides the ASCII rune that is used for padding with a string length of `opts.width`.{{}} {{}}Converts a value to an 48-bit integer.{{}} ### `type float` @@ -178,12 +178,12 @@ print typeof('my str').id() {{}}{{}} {{}}Appends a value to the end of the list.{{}} {{}}Concats the elements of another list to the end of this list.{{}} -{{}}Inserts a value at index `idx`.{{}} -{{}}Returns a new iterator over the list elements.{{}} +{{}}Inserts a value at index `idx`.{{}} +{{}}Returns a new iterator over the list elements.{{}} {{}}Returns a new string that joins the elements with `separator`.{{}} {{}}Returns the number of elements in the list.{{}} -{{}}Removes an element at index `idx`.{{}} -{{}}Resizes the list to `len` elements. If the new size is bigger, `none` values are appended to the list. If the new size is smaller, elements at the end of the list are removed.{{}} +{{}}Removes an element at index `idx`.{{}} +{{}}Resizes the list to `len` elements. If the new size is bigger, `none` values are appended to the list. If the new size is smaller, elements at the end of the list are removed.{{}} {{}}{{}} {{}}Creates a list with initial capacity of `n` and values set to `val`. If the value is an object, it is shallow copied `n` times.{{}} ### `type ListIterator` @@ -198,7 +198,7 @@ print typeof('my str').id() {{}}{{}} {{}}Removes the element with the given key `key`.{{}} {{}}Returns the number of key-value pairs in the map.{{}} -{{}}Returns a new iterator over the map elements.{{}} +{{}}Returns a new iterator over the map elements.{{}} ### `type MapIterator` {{}}{{}} @@ -229,7 +229,7 @@ print typeof('my str').id() {{}}Converts a value to a string.{{}} ### `type array` -{{}}{{}} +{{}}{{}} {{}}Returns a new array that concats this array and `other`.{{}} {{}}Calls decode(.utf8){{}} {{}}Decodes the array based on an `encoding`. Supported encodings: `.utf8`. Returns the decoded string or throws `error.Decode`.{{}} @@ -237,7 +237,7 @@ print typeof('my str').id() {{}}Returns the first index of `needle` in the array or `none` if not found.{{}} {{}}Returns the first index of any `bytes` in `arrays` or `none` if not found.{{}} {{}}Returns the first index of `byte` in the array or `none` if not found.{{}} -{{}}Formats each byte in the array using a kind specifier which can be binary `.b`, octal `.o`, decimal `.d`, hexadecimal `.x`, ASCII `.c`. Each byte is zero padded.{{}} +{{}}Formats each byte in the array using a kind specifier which can be binary `.b`, octal `.o`, decimal `.d`, hexadecimal `.x`, ASCII `.c`. Each byte is zero padded.{{}} {{}}Returns the byte value (0-255) at the given index `idx`.{{}} {{}}Returns the int value of the 6 bytes starting from `idx` with the given endianness (.little or .big).{{}} {{}}Returns the int value of the 4 bytes starting from `idx` with the given endianness (.little or .big).{{}} @@ -251,7 +251,7 @@ print typeof('my str').id() {{}}{{}} {{}}Returns a list of arrays split at occurrences of `sep`.{{}} {{}}Returns whether the array starts with `prefix`.{{}} -{{}}Returns the array with ends trimmed from runes in `delims`. `mode` can be .left, .right, or .ends.{{}} +{{}}Returns the array with ends trimmed from runes in `delims`. `mode` can be .left, .right, or .ends.{{}} {{}}Converts a string to an byte `array`.{{}} ### `type arrayIterator` @@ -362,54 +362,54 @@ for map -> [k, v]: {{}}Standard output file descriptor.{{}} {{}}The current operating system's tag name.{{}} {{}}Default SIMD vector bit size.{{}} -{{}}Attempts to access a file at the given `path` with the `.read`, `.write`, or `.readWrite` mode. Return true or an error.{{}} -{{}}Returns the command line arguments in a `List`. Each argument is validated and returned as a UTF-8 `string` or `array` if the validation failed.{{}} -{{}}Returns the path of a locally cached file of `url`. If no such file exists locally, it's fetched from `url`.{{}} +{{}}Attempts to access a file at the given `path` with the `.read`, `.write`, or `.readWrite` mode. Throws an error if unsuccessful.{{}} +{{}}Returns the command line arguments in a `List`. Each argument is converted to a `string`.{{}} +{{}}Returns the path of a locally cached file of `url`. If no such file exists locally, it's fetched from `url`.{{}} {{}}Copies a file to a destination path.{{}} {{}}Creates the directory at `path`. Returns `true` if successful.{{}} {{}}Creates and opens the file at `path`. If `truncate` is true, an existing file will be truncated.{{}} {{}}Returns a null terminated C string.{{}} {{}}Returns the current working directory.{{}} -{{}}Returns the given path with its last component removed.{{}} +{{}}Returns the given path with its last component removed.{{}} {{}}Runs a shell command and returns the stdout/stderr.{{}} {{}}Returns the current executable's path.{{}} {{}}Exits the program with a status code.{{}} -{{}}Fetches the contents at `url` using the HTTP GET request method.{{}} +{{}}Fetches the contents at `url` using the HTTP GET request method.{{}} {{}}Frees the memory located at `ptr`.{{}} -{{}}Returns an environment value by key.{{}} -{{}}Returns all environment entries as a `Map`.{{}} -{{}}Reads stdin to the EOF as a `string`.{{}} -{{}}Reads stdin until a new line as a `string`. This is intended to read user input from the command line. For bulk reads from stdin, use `os.stdin`.{{}} +{{}}Returns an environment variable by key.{{}} +{{}}Returns all environment variables as a `Map`.{{}} {{}}Allocates `size` bytes of memory and returns a pointer.{{}} -{{}}Return the calendar timestamp, in milliseconds, relative to UTC 1970-01-01.{{}} +{{}}Return the calendar timestamp, in milliseconds, relative to UTC 1970-01-01. For an high resolution timestamp, use `now()`.{{}} {{}}Returns a new FFI context for declaring C mappings and binding a dynamic library.{{}} {{}}Returns the current time (in high resolution seconds) since an arbitrary point in time.{{}} {{}}Invokes `openDir(path, false)`.{{}} {{}}Opens a directory at the given `path`. `iterable` indicates that the directory's entries can be iterated.{{}} {{}}Opens a file at the given `path` with the `.read`, `.write`, or `.readWrite` mode.{{}} {{}}Given expected `ArgOption`s, returns a map of the options and a `rest` entry which contains the non-option arguments.{{}} -{{}}Reads the file contents from `path` with UTF-8 encoding.{{}} -{{}}Returns the absolute path of the given path.{{}} +{{}}Reads stdin to the EOF as a UTF-8 string. To return the bytes instead, use `stdin.readAll()`.{{}} +{{}}Reads the file contents from `path` as a UTF-8 string. To return the bytes instead, use `File.readAll()`.{{}} +{{}}Reads stdin until a new line as a `string`. This is intended to read user input from the command line. For bulk reads from stdin, use `stdin`.{{}} +{{}}Returns the absolute path of the given path.{{}} {{}}Removes an empty directory at `path`. Returns `true` if successful.{{}} {{}}Removes the file at `path`. Returns `true` if successful.{{}} -{{}}Sets an environment value by key.{{}} +{{}}Sets an environment variable by key.{{}} {{}}Pauses the current thread for given milliseconds.{{}} -{{}}Removes an environment value by key.{{}} -{{}}Writes a string value to a file.{{}} +{{}}Removes an environment variable by key.{{}} +{{}}Writes `contents` as a string or bytes to a file.{{}} ### `type File` {{}}Closes the file handle. File ops invoked afterwards will return `error.Closed`.{{}} {{}}{{}} {{}}{{}} {{}}Reads at most `n` bytes as an `array`. `n` must be at least 1. A result with length 0 indicates the end of file was reached.{{}} -{{}}Reads to the end of the file and returns the content as an `array`.{{}} -{{}}Seeks the read/write position to `pos` bytes from the start. Negative `pos` is invalid.{{}} -{{}}Seeks the read/write position by `pos` bytes from the current position.{{}} -{{}}Seeks the read/write position by `pos` bytes from the end. Positive `pos` is invalid.{{}} +{{}}Reads to the end of the file and returns the content as an `array`.{{}} +{{}}Seeks the read/write position to `pos` bytes from the start. Negative `pos` is invalid.{{}} +{{}}Seeks the read/write position by `pos` bytes from the current position.{{}} +{{}}Seeks the read/write position by `pos` bytes from the end. Positive `pos` is invalid.{{}} {{}}Returns info about the file as a `Map`.{{}} -{{}}Equivalent to `streamLines(4096)`.{{}} -{{}}Returns an iterable that streams lines ending in `\n`, `\r`, `\r\n`, or the `EOF`. The lines returned include the new line character(s). A buffer size of `bufSize` bytes is allocated for reading. If `\r` is found at the end of the read buffer, the line is returned instead of waiting to see if the next read has a connecting `\n`.{{}} -{{}}Writes a `string` or `array` at the current file position. The number of bytes written is returned.{{}} +{{}}Equivalent to `streamLines(4096)`.{{}} +{{}}Returns an iterable that streams lines ending in `\n`, `\r`, `\r\n`, or the `EOF`. The lines returned include the new line character(s). A buffer size of `bufSize` bytes is allocated for reading. If `\r` is found at the end of the read buffer, the line is returned instead of waiting to see if the next read has a connecting `\n`.{{}} +{{}}Writes a `string` or `array` at the current file position. The number of bytes written is returned.{{}} ### `type Dir` {{}}Returns a new iterator over the directory entries. If this directory was not opened with the iterable flag, `error.NotAllowed` is returned instead.{{}}