@grain/stdlib 0.6.6 → 0.7.0

package/string.md

@@ -51,7 +51,7 @@ No other changes yet.
 </details>
 
 ```grain
-concat : (str1: String, str2: String) => String
+concat: (str1: String, str2: String) => String
 ```
 
 Concatenate two strings.
@@ -83,7 +83,7 @@ No other changes yet.
 </details>
 
 ```grain
-length : (string: String) => Number
+length: (string: String) => Number
 ```
 
 Returns the character length of the input string.
@@ -114,7 +114,7 @@ No other changes yet.
 </details>
 
 ```grain
-byteLength : (string: String) => Number
+byteLength: (string: String) => Number
 ```
 
 Returns the byte length of the input string.
@@ -145,7 +145,7 @@ No other changes yet.
 </details>
 
 ```grain
-isEmpty : (string: String) => Bool
+isEmpty: (string: String) => Bool
 ```
 
 Determines if the string contains no characters.
@@ -170,7 +170,7 @@ No other changes yet.
 </details>
 
 ```grain
-indexOf : (search: String, string: String) => Option<Number>
+indexOf: (search: String, string: String) => Option<Number>
 ```
 
 Finds the first position of a substring in the input string.
@@ -202,7 +202,7 @@ No other changes yet.
 </details>
 
 ```grain
-lastIndexOf : (search: String, string: String) => Option<Number>
+lastIndexOf: (search: String, string: String) => Option<Number>
 ```
 
 Finds the last position of a substring in the input string.
@@ -234,7 +234,7 @@ No other changes yet.
 </details>
 
 ```grain
-charCodeAt : (position: Number, string: String) => Number
+charCodeAt: (position: Number, string: String) => Number
 ```
 
 Get the Unicode code point at the position in the input string.
@@ -276,7 +276,7 @@ No other changes yet.
 </details>
 
 ```grain
-charAt : (position: Number, string: String) => Char
+charAt: (position: Number, string: String) => Char
 ```
 
 Get the character at the position in the input string.
@@ -318,7 +318,7 @@ No other changes yet.
 </details>
 
 ```grain
-explode : (string: String) => Array<Char>
+explode: (string: String) => Array<Char>
 ```
 
 Split a string into its Unicode characters.
@@ -355,7 +355,7 @@ No other changes yet.
 </details>
 
 ```grain
-implode : (arr: Array<Char>) => String
+implode: (arr: Array<Char>) => String
 ```
 
 Create a string from an array of characters.
@@ -386,7 +386,7 @@ No other changes yet.
 </details>
 
 ```grain
-reverse : (string: String) => String
+reverse: (string: String) => String
 ```
 
 Create a string that is the given string reversed.
@@ -412,7 +412,7 @@ String.reverse("olleH") == "Hello"
 ### String.**split**
 
 ```grain
-split : (separator: String, string: String) => Array<String>
+split: (separator: String, string: String) => Array<String>
 ```
 
 Split a string by the given separator.
@@ -457,7 +457,7 @@ String.split(" ", "Hello world") == [> "Hello", "world"]
 </details>
 
 ```grain
-slice : (start: Number, ?end: Number, string: String) => String
+slice: (start: Number, ?end: Number, string: String) => String
 ```
 
 Get a portion of a string.
@@ -507,7 +507,7 @@ No other changes yet.
 </details>
 
 ```grain
-contains : (search: String, string: String) => Bool
+contains: (search: String, string: String) => Bool
 ```
 
 Check if a string contains a substring.
@@ -539,7 +539,7 @@ No other changes yet.
 </details>
 
 ```grain
-startsWith : (search: String, string: String) => Bool
+startsWith: (search: String, string: String) => Bool
 ```
 
 Check if a string begins with another string.
@@ -571,7 +571,7 @@ No other changes yet.
 </details>
 
 ```grain
-endsWith : (search: String, string: String) => Bool
+endsWith: (search: String, string: String) => Bool
 ```
 
 Check if a string ends with another string.
@@ -603,7 +603,7 @@ No other changes yet.
 </details>
 
 ```grain
-replaceFirst :
+replaceFirst:
   (searchPattern: String, replacement: String, string: String) => String
 ```
 
@@ -637,7 +637,7 @@ No other changes yet.
 </details>
 
 ```grain
-replaceLast :
+replaceLast:
   (searchPattern: String, replacement: String, string: String) => String
 ```
 
@@ -671,7 +671,7 @@ No other changes yet.
 </details>
 
 ```grain
-replaceAll :
+replaceAll:
   (searchPattern: String, replacement: String, string: String) => String
 ```
 
@@ -712,7 +712,7 @@ String.replaceAll("🌾", "🌎", "Hello 🌾🌾") == "Hello 🌎🌎"
 </details>
 
 ```grain
-encodeAt :
+encodeAt:
   (string: String, encoding: Encoding, dest: Bytes, destPos: Number,
    ?includeBom: Bool) => Bytes
 ```
@@ -757,7 +757,7 @@ Throws:
 </details>
 
 ```grain
-encode : (string: String, encoding: Encoding, ?includeBom: Bool) => Bytes
+encode: (string: String, encoding: Encoding, ?includeBom: Bool) => Bytes
 ```
 
 Encodes the given string using the given encoding scheme.
@@ -791,7 +791,7 @@ Returns:
 </details>
 
 ```grain
-decodeRange :
+decodeRange:
   (bytes: Bytes, encoding: Encoding, start: Number, size: Number,
    ?keepBom: Bool) => String
 ```
@@ -838,7 +838,7 @@ Throws:
 </details>
 
 ```grain
-decode : (bytes: Bytes, encoding: Encoding, ?keepBom: Bool) => String
+decode: (bytes: Bytes, encoding: Encoding, ?keepBom: Bool) => String
 ```
 
 Decodes the given byte sequence into a string using the given encoding scheme.
@@ -865,7 +865,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachCodePoint : (fn: (Number => Void), str: String) => Void
+forEachCodePoint: (fn: (Number => Void), str: String) => Void
 ```
 
 Iterates over Unicode code points in a string.
@@ -891,7 +891,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachCodePointi : (fn: ((Number, Number) => Void), str: String) => Void
+forEachCodePointi: (fn: ((Number, Number) => Void), str: String) => Void
 ```
 
 Iterates over Unicode code points in a string. This is the same as
@@ -919,7 +919,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachChar : (fn: (Char => Void), str: String) => Void
+forEachChar: (fn: (Char => Void), str: String) => Void
 ```
 
 Iterates over Unicode characters in a string.
@@ -945,7 +945,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachChari : (fn: ((Char, Number) => Void), str: String) => Void
+forEachChari: (fn: ((Char, Number) => Void), str: String) => Void
 ```
 
 Iterates over Unicode characters in a string. This is the same as
@@ -973,7 +973,7 @@ No other changes yet.
 </details>
 
 ```grain
-map : (fn: (Char => Char), str: String) => String
+map: (fn: (Char => Char), str: String) => String
 ```
 
 Builds a new string by mapping Unicode characters.
@@ -999,7 +999,7 @@ No other changes yet.
 </details>
 
 ```grain
-mapi : (fn: ((Char, Number) => Char), str: String) => String
+mapi: (fn: ((Char, Number) => Char), str: String) => String
 ```
 
 Builds a new string by mapping Unicode characters. This is the same as
@@ -1027,7 +1027,7 @@ No other changes yet.
 </details>
 
 ```grain
-trimStart : (string: String) => String
+trimStart: (string: String) => String
 ```
 
 Trims the beginning of a string—removing any leading whitespace characters.
@@ -1058,7 +1058,7 @@ No other changes yet.
 </details>
 
 ```grain
-trimEnd : (string: String) => String
+trimEnd: (string: String) => String
 ```
 
 Trims the end of a string—removing any trailing whitespace characters.
@@ -1089,7 +1089,7 @@ No other changes yet.
 </details>
 
 ```grain
-trim : (string: String) => String
+trim: (string: String) => String
 ```
 
 Trims a string—removing all leading and trailing whitespace characters.
@@ -1120,7 +1120,7 @@ No other changes yet.
 </details>
 
 ```grain
-toAsciiLowercase : (string: String) => String
+toAsciiLowercase: (string: String) => String
 ```
 
 Converts all ASCII uppercase characters in the string to lowercase.
@@ -1151,7 +1151,7 @@ No other changes yet.
 </details>
 
 ```grain
-toAsciiUppercase : (string: String) => String
+toAsciiUppercase: (string: String) => String
 ```
 
 Converts all ASCII lowercase characters in the string to uppercase.
@@ -1174,3 +1174,46 @@ Examples:
 assert String.toAsciiUppercase("aBc123") == "ABC123"
 ```
 
+### String.**repeat**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.7</code></summary>
+No other changes yet.
+</details>
+
+```grain
+repeat: (count: Number, string: String) => String
+```
+
+Produces a new string by repeating a substring a given number of times.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`count`|`Number`|The number of times to repeat the string|
+|`string`|`String`|The string to repeat|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`String`|A string containing the repeated input string|
+
+Throws:
+
+`InvalidArgument(String)`
+
+* When the `count` is not an integer
+* When the `count` is negative
+
+Examples:
+
+```grain
+assert String.repeat(5, "=") == "====="
+```
+
+```grain
+assert String.repeat(0, ".") == ""
+```
+

package/uint16.md

@@ -33,7 +33,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromNumber : (number: Number) => Uint16
+fromNumber: (number: Number) => Uint16
 ```
 
 Converts a Number to a Uint16.
@@ -58,7 +58,7 @@ No other changes yet.
 </details>
 
 ```grain
-toNumber : (value: Uint16) => Number
+toNumber: (value: Uint16) => Number
 ```
 
 Converts a Uint16 to a Number.
@@ -83,7 +83,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromInt16 : (number: Int16) => Uint16
+fromInt16: (number: Int16) => Uint16
 ```
 
 Converts an Int16 to a Uint16.
@@ -118,7 +118,7 @@ No other changes yet.
 </details>
 
 ```grain
-incr : (value: Uint16) => Uint16
+incr: (value: Uint16) => Uint16
 ```
 
 Increments the value by one.
@@ -149,7 +149,7 @@ No other changes yet.
 </details>
 
 ```grain
-decr : (value: Uint16) => Uint16
+decr: (value: Uint16) => Uint16
 ```
 
 Decrements the value by one.
@@ -184,7 +184,7 @@ No other changes yet.
 </details>
 
 ```grain
-(+) : (x: Uint16, y: Uint16) => Uint16
+(+): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the sum of its operands.
@@ -217,7 +217,7 @@ No other changes yet.
 </details>
 
 ```grain
-(-) : (x: Uint16, y: Uint16) => Uint16
+(-): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the difference of its operands.
@@ -250,7 +250,7 @@ No other changes yet.
 </details>
 
 ```grain
-(*) : (x: Uint16, y: Uint16) => Uint16
+(*): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the product of its operands.
@@ -283,7 +283,7 @@ No other changes yet.
 </details>
 
 ```grain
-(/) : (x: Uint16, y: Uint16) => Uint16
+(/): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the quotient of its operands.
@@ -316,7 +316,7 @@ No other changes yet.
 </details>
 
 ```grain
-rem : (x: Uint16, y: Uint16) => Uint16
+rem: (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the remainder of the division of its operands.
@@ -348,7 +348,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<<) : (value: Uint16, amount: Uint16) => Uint16
+(<<): (value: Uint16, amount: Uint16) => Uint16
 ```
 
 Shifts the bits of the value left by the given number of bits.
@@ -381,7 +381,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>>>) : (value: Uint16, amount: Uint16) => Uint16
+(>>>): (value: Uint16, amount: Uint16) => Uint16
 ```
 
 Shifts the bits of the value right by the given number of bits.
@@ -414,7 +414,7 @@ No other changes yet.
 </details>
 
 ```grain
-(==) : (x: Uint16, y: Uint16) => Bool
+(==): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is equal to the second value.
@@ -447,7 +447,7 @@ No other changes yet.
 </details>
 
 ```grain
-(!=) : (x: Uint16, y: Uint16) => Bool
+(!=): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is not equal to the second value.
@@ -480,7 +480,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<) : (x: Uint16, y: Uint16) => Bool
+(<): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is less than the second value.
@@ -513,7 +513,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>) : (x: Uint16, y: Uint16) => Bool
+(>): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is greater than the second value.
@@ -546,7 +546,7 @@ No other changes yet.
 </details>
 
 ```grain
-(<=) : (x: Uint16, y: Uint16) => Bool
+(<=): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is less than or equal to the second value.
@@ -584,7 +584,7 @@ No other changes yet.
 </details>
 
 ```grain
-(>=) : (x: Uint16, y: Uint16) => Bool
+(>=): (x: Uint16, y: Uint16) => Bool
 ```
 
 Checks if the first value is greater than or equal to the second value.
@@ -622,7 +622,7 @@ No other changes yet.
 </details>
 
 ```grain
-lnot : (value: Uint16) => Uint16
+lnot: (value: Uint16) => Uint16
 ```
 
 Computes the bitwise NOT of the given value.
@@ -653,7 +653,7 @@ No other changes yet.
 </details>
 
 ```grain
-(&) : (x: Uint16, y: Uint16) => Uint16
+(&): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the bitwise AND (`&`) on the given operands.
@@ -686,7 +686,7 @@ No other changes yet.
 </details>
 
 ```grain
-(|) : (x: Uint16, y: Uint16) => Uint16
+(|): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the bitwise OR (`|`) on the given operands.
@@ -719,7 +719,7 @@ No other changes yet.
 </details>
 
 ```grain
-(^) : (x: Uint16, y: Uint16) => Uint16
+(^): (x: Uint16, y: Uint16) => Uint16
 ```
 
 Computes the bitwise XOR (`^`) on the given operands.

package/uint32.gr

@@ -6,6 +6,12 @@
  */
 module Uint32
 
+from "runtime/unsafe/offsets" include Offsets
+use Offsets.{
+  _UINT32_VALUE_OFFSET as _VALUE_OFFSET,
+  _INT32_VALUE_OFFSET,
+  _FLOAT32_VALUE_OFFSET,
+}
 from "runtime/unsafe/wasmi32" include WasmI32
 use WasmI32.{ (+), (-), (*), (&), (|), (^), (<<), (>>>), (==), (!=) }
 from "runtime/unsafe/wasmi64" include WasmI64
@@ -16,9 +22,6 @@ use Numbers.{ reducedUnsignedInteger, coerceNumberToUnsignedWasmI32 }
 from "runtime/dataStructures" include DataStructures
 use DataStructures.{ newUint32 }
 
-@unsafe
-let _VALUE_OFFSET = 4n
-
 /**
  * Converts a Number to a Uint32.
  *
@@ -60,7 +63,25 @@ provide let toNumber = (value: Uint32) => {
  */
 @unsafe
 provide let fromInt32 = (number: Int32) => {
-  let x = WasmI32.load(WasmI32.fromGrain(number), _VALUE_OFFSET)
+  let x = WasmI32.load(WasmI32.fromGrain(number), _INT32_VALUE_OFFSET)
+  let result = newUint32(x)
+  WasmI32.toGrain(result): Uint32
+}
+
+/**
+ * Interprets a Float32 as an Uint32.
+ *
+ * @param value: The value to convert
+ * @returns The Float32 interpreted as an Uint32
+ *
+ * @example assert Uint32.reinterpretFloat32(1.0f) == 1065353216ul
+ * @example assert Uint32.reinterpretFloat32(-1.0f) == 3212836864ul
+ *
+ * @since v0.7.0
+ */
+@unsafe
+provide let reinterpretFloat32 = (value: Float32) => {
+  let x = WasmI32.load(WasmI32.fromGrain(value), _FLOAT32_VALUE_OFFSET)
   let result = newUint32(x)
   WasmI32.toGrain(result): Uint32
 }