@grain/stdlib 0.6.6 → 0.7.0

package/char.md

@@ -27,6 +27,27 @@ from "char" include Char
 '🌾'
 ```
 
+## Types
+
+Type declarations included in the Char module.
+
+### Char.**Encoding**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+enum Encoding {
+  UTF8,
+  UTF16,
+  UTF32,
+}
+```
+
+Byte encodings
+
 ## Values
 
 Functions and constants included in the Char module.
@@ -39,7 +60,7 @@ No other changes yet.
 </details>
 
 ```grain
-min : Number
+min: Number
 ```
 
 The minimum valid Unicode scalar value.
@@ -52,7 +73,7 @@ No other changes yet.
 </details>
 
 ```grain
-max : Number
+max: Number
 ```
 
 The maximum valid Unicode scalar value.
@@ -65,7 +86,7 @@ No other changes yet.
 </details>
 
 ```grain
-isValid : (charCode: Number) => Bool
+isValid: (charCode: Number) => Bool
 ```
 
 Determines whether the given character code is a valid Unicode scalar value.
@@ -100,7 +121,7 @@ No other changes yet.
 </details>
 
 ```grain
-code : (char: Char) => Number
+code: (char: Char) => Number
 ```
 
 Determines the Unicode scalar value for a character.
@@ -135,7 +156,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromCode : (usv: Number) => Char
+fromCode: (usv: Number) => Char
 ```
 
 Creates a character from the given Unicode scalar value.
@@ -176,7 +197,7 @@ No other changes yet.
 </details>
 
 ```grain
-succ : (char: Char) => Char
+succ: (char: Char) => Char
 ```
 
 Returns the next valid character by Unicode scalar value.
@@ -217,7 +238,7 @@ No other changes yet.
 </details>
 
 ```grain
-pred : (char: Char) => Char
+pred: (char: Char) => Char
 ```
 
 Returns the previous valid character by Unicode scalar value.
@@ -258,7 +279,7 @@ No other changes yet.
 </details>
 
 ```grain
-toString : (char: Char) => String
+toString: (char: Char) => String
 ```
 
 Converts the given character to a string.
@@ -285,6 +306,46 @@ Char.toString('a') == "a"
 Char.toString('🌾') == "🌾"
 ```
 
+### Char.**encodedLength**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+encodedLength: (encoding: Encoding, char: Char) => Number
+```
+
+Returns the byte count of a character if encoded in the given encoding.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`encoding`|`Encoding`|The encoding to check|
+|`char`|`Char`|The character|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Number`|The byte count of the character in the given encoding|
+
+Examples:
+
+```grain
+Char.encodedLength(Char.UTF8, 'a') == 1
+```
+
+```grain
+Char.encodedLength(Char.UTF8, '🌾') == 4
+```
+
+```grain
+Char.encodedLength(Char.UTF16, '©') == 1
+```
+
 ### Char.**(<)**
 
 <details disabled>
@@ -293,7 +354,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<) : (x: Char, y: Char) => Bool
+(<): (x: Char, y: Char) => Bool
 ```
 
 Checks if the first character is less than the second character by Unicode scalar value.
@@ -331,7 +392,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<=) : (x: Char, y: Char) => Bool
+(<=): (x: Char, y: Char) => Bool
 ```
 
 Checks if the first character is less than or equal to the second character by Unicode scalar value.
@@ -374,7 +435,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>) : (x: Char, y: Char) => Bool
+(>): (x: Char, y: Char) => Bool
 ```
 
 Checks if the first character is greater than the second character by Unicode scalar value.
@@ -412,7 +473,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>=) : (x: Char, y: Char) => Bool
+(>=): (x: Char, y: Char) => Bool
 ```
 
 Checks if the first character is greater than or equal to the second character by Unicode scalar value.
@@ -447,15 +508,104 @@ use Char.{ (>=) }
 assert 'a' >= 'a'
 ```
 
-### Char.**isAsciiDigit**
+## Char.Ascii
+
+Utilities for working with ASCII characters.
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
 No other changes yet.
 </details>
 
 ```grain
-isAsciiDigit : (char: Char) => Bool
+Char.Ascii.isAscii('1')
+```
+
+### Values
+
+Functions and constants included in the Char.Ascii module.
+
+#### Char.Ascii.**min**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+min: Number
+```
+
+The minimum valid ASCII character code.
+
+#### Char.Ascii.**max**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+max: Number
+```
+
+The maximum valid ASCII character code.
+
+#### Char.Ascii.**isValid**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isValid: (char: Char) => Bool
+```
+
+Checks if the character is a valid ASCII character.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`char`|`Char`|The character to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the character is an ASCII character or `false` otherwise|
+
+Examples:
+
+```grain
+assert Char.Ascii.isValid('1')
+```
+
+```grain
+assert Char.Ascii.isValid('a')
+```
+
+```grain
+assert !Char.Ascii.isValid('🌾')
+```
+
+#### Char.Ascii.**isDigit**
+
+<details>
+<summary>Added in <code>0.7.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>Originally `Char.isAsciiDigit`</td></tr>
+</tbody>
+</table>
+</details>
+
+```grain
+isDigit: (char: Char) => Bool
 ```
 
 Checks if the character is an ASCII digit.
@@ -475,22 +625,29 @@ Returns:
 Examples:
 
 ```grain
-assert Char.isAsciiDigit('1')
+assert Char.Ascii.isDigit('1')
 ```
 
 ```grain
-assert !Char.isAsciiDigit('a')
+assert !Char.Ascii.isDigit('a')
 ```
 
-### Char.**isAsciiAlpha**
+#### Char.Ascii.**isAlpha**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.6.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.7.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>Originally `Char.isAsciiAlpha`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-isAsciiAlpha : (char: Char) => Bool
+isAlpha: (char: Char) => Bool
 ```
 
 Checks if the character is an ASCII alphabetical character.
@@ -510,22 +667,185 @@ Returns:
 Examples:
 
 ```grain
-assert Char.isAsciiAlpha('a')
+assert Char.Ascii.isAlpha('a')
 ```
 
 ```grain
-assert !Char.isAsciiAlpha('1')
+assert !Char.Ascii.isAlpha('1')
 ```
 
-### Char.**toAsciiLowercase**
+#### Char.Ascii.**isControl**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isControl: (char: Char) => Bool
+```
+
+Checks if the character is an ASCII control character.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`char`|`Char`|The character to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the character is an ASCII control character or `false` otherwise|
+
+Examples:
+
+```grain
+assert Char.Ascii.isControl('\t')
+```
+
+```grain
+assert Char.Ascii.isControl('\n')
+```
+
+```grain
+assert !Char.Ascii.isControl('1')
+```
+
+```grain
+assert !Char.Ascii.isControl('a')
+```
+
+#### Char.Ascii.**isWhitespace**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isWhitespace: (char: Char) => Bool
+```
+
+Checks if the character is an ASCII whitespace character.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`char`|`Char`|The character to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the character is an ASCII whitespace character or `false` otherwise|
+
+Examples:
+
+```grain
+assert Char.isWhitespace('\t')
+```
+
+```grain
+assert Char.isWhitespace('\n')
+```
+
+```grain
+assert !Char.isWhitespace('1')
+```
+
+```grain
+assert !Char.isWhitespace('a')
+```
+
+#### Char.Ascii.**isPunctuation**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
 No other changes yet.
 </details>
 
 ```grain
-toAsciiLowercase : (char: Char) => Char
+isPunctuation: (char: Char) => Bool
+```
+
+Checks if the character is an ASCII punctuation character.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`char`|`Char`|The character to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the character is an ASCII punctuation character or `false` otherwise|
+
+Examples:
+
+```grain
+assert Char.Ascii.isPunctuation('!')
+```
+
+```grain
+assert !Char.Ascii.isPunctuation('1')
+```
+
+#### Char.Ascii.**isGraphic**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+isGraphic: (char: Char) => Bool
+```
+
+Checks if the character is an ASCII graphic character.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`char`|`Char`|The character to check|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Bool`|`true` if the character is an ASCII graphic character or `false` otherwise|
+
+Examples:
+
+```grain
+assert Char.Ascii.isGraphic('!')
+```
+
+```grain
+assert !Char.Ascii.isGraphic('\t')
+```
+
+#### Char.Ascii.**toLowercase**
+
+<details>
+<summary>Added in <code>0.7.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>Originally `Char.toAsciiLowercase`</td></tr>
+</tbody>
+</table>
+</details>
+
+```grain
+toLowercase: (char: Char) => Char
 ```
 
 Converts the character to ASCII lowercase if it is an ASCII uppercase character.
@@ -545,18 +865,25 @@ Returns:
 Examples:
 
 ```grain
-assert Char.toAsciiLowercase('B') == 'b'
+assert Char.Ascii.toLowercase('B') == 'b'
 ```
 
-### Char.**toAsciiUppercase**
+#### Char.Ascii.**toUppercase**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.6.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.7.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>Originally `Char.toAsciiUppercase`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-toAsciiUppercase : (char: Char) => Char
+toUppercase: (char: Char) => Char
 ```
 
 Converts the character to ASCII uppercase if it is an ASCII lowercase character.
@@ -576,6 +903,6 @@ Returns:
 Examples:
 
 ```grain
-assert Char.toAsciiUppercase('b') == 'B'
+assert Char.Ascii.toUppercase('b') == 'B'
 ```
 

package/exception.gr

@@ -12,8 +12,6 @@
  */
 module Exception
 
-from "runtime/unsafe/wasmi32" include WasmI32
-from "runtime/unsafe/memory" include Memory
 from "runtime/exception" include Exception
 
 /**
@@ -39,13 +37,15 @@ from "runtime/exception" include Exception
  *
  * @since v0.3.0
  */
-@disableGC
-provide let rec registerPrinter = (printer: Exception => Option<String>) => {
-  // This function _must_ be @disableGC because the printer list uses
-  // unsafe types. Not really a memory leak as this list is never collected
+provide let registerPrinter = Exception.registerPrinter
 
-  // no need to increment refcount on f; we just don't decRef it at the end of the function
-  Exception.printers = WasmI32.fromGrain((printer, Exception.printers))
-  Memory.decRef(WasmI32.fromGrain(registerPrinter))
-  void
-}
+/**
+ * Gets the string representation of the given exception.
+ *
+ * @param e: The exception to stringify
+ *
+ * @returns The string representation of the exception
+ *
+ * @since v0.7.0
+ */
+provide let toString = Exception.toString

package/exception.md

@@ -35,7 +35,7 @@ No other changes yet.
 </details>
 
 ```grain
-registerPrinter : (printer: (Exception => Option<String>)) => Void
+registerPrinter: (printer: (Exception => Option<String>)) => Void
 ```
 
 Registers an exception printer. When an exception is thrown, all registered
@@ -65,3 +65,28 @@ Exception.registerPrinter(e => {
 throw ExampleError(1) // Error found on line: 1
 ```
 
+### Exception.**toString**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.7.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+toString: (e: Exception) => String
+```
+
+Gets the string representation of the given exception.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`e`|`Exception`|The exception to stringify|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`String`|The string representation of the exception|
+