@grain/stdlib 0.5.4 → 0.5.6

package/buffer.md

@@ -47,6 +47,12 @@ Returns:
 |----|-----------|
 |`Buffer`|The new buffer|
 
+Throws:
+
+`InvalidArgument(String)`
+
+* When the `initialSize` is a negative number
+
 ### Buffer.**length**
 
 <details disabled>
@@ -136,6 +142,13 @@ Parameters:
 |`length`|`Number`|The number of bytes to truncate the buffer to|
 |`buffer`|`Buffer`|The buffer to truncate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When the `length` is negative
+* When the `length` is greater than the buffer size
+
 ### Buffer.**toBytes**
 
 <details disabled>
@@ -188,6 +201,14 @@ Returns:
 |----|-----------|
 |`Bytes`|A byte sequence with bytes copied from the buffer|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `start` is negative
+* When `start` is greater than or equal to the buffer size
+* When `start + length` is greater than the buffer size
+
 ### Buffer.**toString**
 
 <details disabled>
@@ -351,6 +372,15 @@ Parameters:
 |`bytes`|`Bytes`|The byte sequence to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When the `start` is negative
+* When the `start` is greater than or equal to the `bytes` size
+* When the `length` is negative
+* When the `length` is greater than the `bytes` length minus `start`
+
 ### Buffer.**addBuffer**
 
 <details disabled>
@@ -427,6 +457,14 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing a signed 8-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 1` is greater than the buffer size
+
 ### Buffer.**getInt8U**
 
 <details disabled>
@@ -453,6 +491,14 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing an unsigned 8-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 1` is greater than the buffer size
+
 ### Buffer.**setInt8**
 
 <details disabled>
@@ -474,6 +520,14 @@ Parameters:
 |`value`|`Int32`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 1` is greater than the buffer size
+
 ### Buffer.**addInt8**
 
 <details disabled>
@@ -520,6 +574,14 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing a signed 16-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 2` is greater than the buffer size
+
 ### Buffer.**getInt16U**
 
 <details disabled>
@@ -546,6 +608,14 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing an unsigned 16-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 2` is greater than the buffer size
+
 ### Buffer.**setInt16**
 
 <details disabled>
@@ -567,6 +637,14 @@ Parameters:
 |`value`|`Int32`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 2` is greater than the buffer size
+
 ### Buffer.**addInt16**
 
 <details disabled>
@@ -613,6 +691,14 @@ Returns:
 |----|-----------|
 |`Int32`|A signed 32-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
 ### Buffer.**setInt32**
 
 <details disabled>
@@ -634,6 +720,14 @@ Parameters:
 |`value`|`Int32`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
 ### Buffer.**addInt32**
 
 <details disabled>
@@ -680,6 +774,14 @@ Returns:
 |----|-----------|
 |`Float32`|A 32-bit float that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
 ### Buffer.**setFloat32**
 
 <details disabled>
@@ -701,6 +803,14 @@ Parameters:
 |`value`|`Float32`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
 ### Buffer.**addFloat32**
 
 <details disabled>
@@ -747,6 +857,14 @@ Returns:
 |----|-----------|
 |`Int64`|A signed 64-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 8` is greater than the buffer size
+
 ### Buffer.**setInt64**
 
 <details disabled>
@@ -768,6 +886,14 @@ Parameters:
 |`value`|`Int64`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 8` is greater than the buffer size
+
 ### Buffer.**addInt64**
 
 <details disabled>
@@ -814,6 +940,14 @@ Returns:
 |----|-----------|
 |`Float64`|A 64-bit float that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 8` is greater than the buffer size
+
 ### Buffer.**setFloat64**
 
 <details disabled>
@@ -835,6 +969,14 @@ Parameters:
 |`value`|`Float64`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 8` is greater than the buffer size
+
 ### Buffer.**addFloat64**
 
 <details disabled>

package/bytes.gr

@@ -153,6 +153,8 @@ export let copy = (b: Bytes) => {
  * @param bytes: The byte sequence to copy from
  * @returns A byte sequence with of the copied bytes
  *
+ * @throws InvalidArgument(String): When `start + length` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -186,6 +188,8 @@ export let slice = (start: Number, length: Number, bytes: Bytes) => {
  * @param bytes: The byte sequence get a subset of bytes from
  * @returns A resized byte sequence
  *
+ * @throws InvalidArgument(String): When the new size is negative
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -241,6 +245,9 @@ export let resize = (left: Number, right: Number, bytes: Bytes) => {
  * @param src: The source byte sequence
  * @param dst: The destination byte sequence
  *
+ * @throws InvalidArgument(String): When `srcIndex + length` is greater than the `src` bytes size
+ * @throws InvalidArgument(String): When the `dstIndex + length` is greater than the `dst` bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -338,6 +345,9 @@ export let clear = (bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A 32-bit integer representing a signed 8-bit integer that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 1` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -358,10 +368,13 @@ export let getInt8S = (index: Number, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A 32-bit integer representing an unsigned 8-bit integer that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 1` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
-export let rec getInt8U = (index: Number, bytes: Bytes) => {
+export let getInt8U = (index: Number, bytes: Bytes) => {
   let (+) = WasmI32.add
   let ptr = WasmI32.fromGrain(bytes)
   let size = getSize(ptr)
@@ -378,10 +391,13 @@ export let rec getInt8U = (index: Number, bytes: Bytes) => {
  * @param value: The value to set
  * @param bytes: The byte sequence to mutate
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 1` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
-export let rec setInt8 = (index: Number, value: Int32, bytes: Bytes) => {
+export let setInt8 = (index: Number, value: Int32, bytes: Bytes) => {
   let (+) = WasmI32.add
   let ptr = WasmI32.fromGrain(bytes)
   let size = getSize(ptr)
@@ -398,6 +414,9 @@ export let rec setInt8 = (index: Number, value: Int32, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A 32-bit integer representing a signed 16-bit integer that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 2` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -418,6 +437,9 @@ export let getInt16S = (index: Number, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A 32-bit integer representing an unsigned 16-bit integer that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 2` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -438,6 +460,9 @@ export let getInt16U = (index: Number, bytes: Bytes) => {
  * @param value: The value to set
  * @param bytes: The byte sequence to mutate
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 2` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -458,6 +483,9 @@ export let setInt16 = (index: Number, value: Int32, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A signed 32-bit integer that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 4` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -478,6 +506,9 @@ export let getInt32 = (index: Number, bytes: Bytes) => {
  * @param value: The value to set
  * @param bytes: The byte sequence to mutate
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 4` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -498,6 +529,9 @@ export let setInt32 = (index: Number, value: Int32, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A 32-bit float that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 4` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -518,6 +552,9 @@ export let getFloat32 = (index: Number, bytes: Bytes) => {
  * @param value: The value to set
  * @param bytes: The byte sequence to mutate
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 4` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -538,6 +575,9 @@ export let setFloat32 = (index: Number, value: Float32, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A signed 64-bit integer that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 8` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -558,6 +598,9 @@ export let getInt64 = (index: Number, bytes: Bytes) => {
  * @param value: The value to set
  * @param bytes: The byte sequence to mutate
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 8` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -578,6 +621,9 @@ export let setInt64 = (index: Number, value: Int64, bytes: Bytes) => {
  * @param bytes: The byte sequence to access
  * @returns A 64-bit float that starts at the given index
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 8` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
@@ -598,10 +644,13 @@ export let getFloat64 = (index: Number, bytes: Bytes) => {
  * @param value: The value to set
  * @param bytes: The byte sequence to mutate
  *
+ * @throws IndexOutOfBounds: When `index` is negative
+ * @throws IndexOutOfBounds: When `index + 8` is greater than the bytes size
+ *
  * @since v0.3.2
  */
 @unsafe
-export let rec setFloat64 = (index: Number, value: Float64, bytes: Bytes) => {
+export let setFloat64 = (index: Number, value: Float64, bytes: Bytes) => {
   let (+) = WasmI32.add
   let ptr = WasmI32.fromGrain(bytes)
   let size = getSize(ptr)

package/bytes.md

@@ -182,6 +182,12 @@ Returns:
 |----|-----------|
 |`Bytes`|A byte sequence with of the copied bytes|
 
+Throws:
+
+`InvalidArgument(String)`
+
+* When `start + length` is greater than the bytes size
+
 ### Bytes.**resize**
 
 <details disabled>
@@ -211,6 +217,12 @@ Returns:
 |----|-----------|
 |`Bytes`|A resized byte sequence|
 
+Throws:
+
+`InvalidArgument(String)`
+
+* When the new size is negative
+
 ### Bytes.**move**
 
 <details disabled>
@@ -235,6 +247,13 @@ Parameters:
 |`src`|`Bytes`|The source byte sequence|
 |`dst`|`Bytes`|The destination byte sequence|
 
+Throws:
+
+`InvalidArgument(String)`
+
+* When `srcIndex + length` is greater than the `src` bytes size
+* When the `dstIndex + length` is greater than the `dst` bytes size
+
 ### Bytes.**concat**
 
 <details disabled>
@@ -330,6 +349,13 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing a signed 8-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 1` is greater than the bytes size
+
 ### Bytes.**getInt8U**
 
 <details disabled>
@@ -356,6 +382,13 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing an unsigned 8-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 1` is greater than the bytes size
+
 ### Bytes.**setInt8**
 
 <details disabled>
@@ -377,6 +410,13 @@ Parameters:
 |`value`|`Int32`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 1` is greater than the bytes size
+
 ### Bytes.**getInt16S**
 
 <details disabled>
@@ -403,6 +443,13 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing a signed 16-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 2` is greater than the bytes size
+
 ### Bytes.**getInt16U**
 
 <details disabled>
@@ -429,6 +476,13 @@ Returns:
 |----|-----------|
 |`Int32`|A 32-bit integer representing an unsigned 16-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 2` is greater than the bytes size
+
 ### Bytes.**setInt16**
 
 <details disabled>
@@ -450,6 +504,13 @@ Parameters:
 |`value`|`Int32`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 2` is greater than the bytes size
+
 ### Bytes.**getInt32**
 
 <details disabled>
@@ -476,6 +537,13 @@ Returns:
 |----|-----------|
 |`Int32`|A signed 32-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 4` is greater than the bytes size
+
 ### Bytes.**setInt32**
 
 <details disabled>
@@ -497,6 +565,13 @@ Parameters:
 |`value`|`Int32`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 4` is greater than the bytes size
+
 ### Bytes.**getFloat32**
 
 <details disabled>
@@ -523,6 +598,13 @@ Returns:
 |----|-----------|
 |`Float32`|A 32-bit float that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 4` is greater than the bytes size
+
 ### Bytes.**setFloat32**
 
 <details disabled>
@@ -544,6 +626,13 @@ Parameters:
 |`value`|`Float32`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 4` is greater than the bytes size
+
 ### Bytes.**getInt64**
 
 <details disabled>
@@ -570,6 +659,13 @@ Returns:
 |----|-----------|
 |`Int64`|A signed 64-bit integer that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 8` is greater than the bytes size
+
 ### Bytes.**setInt64**
 
 <details disabled>
@@ -591,6 +687,13 @@ Parameters:
 |`value`|`Int64`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 8` is greater than the bytes size
+
 ### Bytes.**getFloat64**
 
 <details disabled>
@@ -617,6 +720,13 @@ Returns:
 |----|-----------|
 |`Float64`|A 64-bit float that starts at the given index|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 8` is greater than the bytes size
+
 ### Bytes.**setFloat64**
 
 <details disabled>
@@ -638,3 +748,10 @@ Parameters:
 |`value`|`Float64`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 8` is greater than the bytes size
+