@grain/stdlib 0.6.6 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (137) hide show
  1. package/CHANGELOG.md +67 -0
  2. package/LICENSE +1 -1
  3. package/README.md +2 -2
  4. package/array.gr +55 -7
  5. package/array.md +606 -560
  6. package/bigint.md +228 -228
  7. package/buffer.gr +85 -53
  8. package/buffer.md +442 -319
  9. package/bytes.gr +112 -35
  10. package/bytes.md +299 -219
  11. package/char.gr +201 -99
  12. package/char.md +447 -120
  13. package/exception.gr +11 -11
  14. package/exception.md +29 -4
  15. package/float32.gr +327 -3
  16. package/float32.md +698 -111
  17. package/float64.gr +320 -3
  18. package/float64.md +698 -111
  19. package/fs.gr +1082 -0
  20. package/fs.md +630 -0
  21. package/hash.gr +142 -88
  22. package/hash.md +105 -17
  23. package/int16.md +178 -178
  24. package/int32.gr +26 -5
  25. package/int32.md +266 -231
  26. package/int64.gr +27 -2
  27. package/int64.md +266 -231
  28. package/int8.md +178 -178
  29. package/json.gr +366 -51
  30. package/json.md +431 -15
  31. package/list.gr +328 -31
  32. package/list.md +759 -336
  33. package/map.gr +20 -12
  34. package/map.md +266 -260
  35. package/marshal.gr +41 -40
  36. package/marshal.md +14 -14
  37. package/number.gr +278 -35
  38. package/number.md +688 -269
  39. package/option.md +162 -162
  40. package/package.json +5 -3
  41. package/path.gr +48 -0
  42. package/path.md +180 -89
  43. package/pervasives.gr +2 -2
  44. package/pervasives.md +275 -275
  45. package/priorityqueue.gr +7 -7
  46. package/priorityqueue.md +131 -131
  47. package/queue.gr +183 -29
  48. package/queue.md +404 -148
  49. package/random.md +43 -43
  50. package/range.gr +4 -4
  51. package/range.md +42 -42
  52. package/rational.md +123 -123
  53. package/regex.gr +52 -51
  54. package/regex.md +102 -102
  55. package/result.md +118 -118
  56. package/runtime/atof/common.md +39 -39
  57. package/runtime/atof/decimal.gr +6 -6
  58. package/runtime/atof/decimal.md +14 -14
  59. package/runtime/atof/lemire.gr +5 -5
  60. package/runtime/atof/lemire.md +1 -1
  61. package/runtime/atof/parse.gr +16 -16
  62. package/runtime/atof/parse.md +2 -2
  63. package/runtime/atof/slow.md +1 -1
  64. package/runtime/atof/table.md +2 -2
  65. package/runtime/atoi/parse.gr +3 -3
  66. package/runtime/atoi/parse.md +1 -1
  67. package/runtime/bigint.gr +15 -47
  68. package/runtime/bigint.md +54 -60
  69. package/runtime/compare.gr +2 -2
  70. package/runtime/compare.md +8 -8
  71. package/runtime/dataStructures.md +211 -211
  72. package/runtime/debugPrint.gr +4 -1
  73. package/runtime/debugPrint.md +9 -9
  74. package/runtime/equal.gr +99 -77
  75. package/runtime/equal.md +8 -8
  76. package/runtime/exception.gr +62 -82
  77. package/runtime/exception.md +62 -11
  78. package/runtime/gc.gr +39 -45
  79. package/runtime/gc.md +4 -4
  80. package/runtime/malloc.gr +7 -7
  81. package/runtime/malloc.md +13 -13
  82. package/runtime/math/kernel/cos.gr +70 -0
  83. package/runtime/math/kernel/cos.md +14 -0
  84. package/runtime/math/kernel/sin.gr +65 -0
  85. package/runtime/math/kernel/sin.md +14 -0
  86. package/runtime/math/kernel/tan.gr +136 -0
  87. package/runtime/math/kernel/tan.md +14 -0
  88. package/runtime/math/rempio2.gr +244 -0
  89. package/runtime/math/rempio2.md +14 -0
  90. package/runtime/math/trig.gr +130 -0
  91. package/runtime/math/trig.md +28 -0
  92. package/runtime/math/umuldi.gr +26 -0
  93. package/runtime/math/umuldi.md +14 -0
  94. package/runtime/numberUtils.gr +29 -29
  95. package/runtime/numberUtils.md +12 -12
  96. package/runtime/numbers.gr +373 -381
  97. package/runtime/numbers.md +348 -342
  98. package/runtime/string.gr +37 -105
  99. package/runtime/string.md +20 -26
  100. package/runtime/unsafe/constants.md +24 -24
  101. package/runtime/unsafe/conv.md +19 -19
  102. package/runtime/unsafe/memory.gr +24 -20
  103. package/runtime/unsafe/memory.md +27 -7
  104. package/runtime/unsafe/offsets.gr +36 -0
  105. package/runtime/unsafe/offsets.md +88 -0
  106. package/runtime/unsafe/panic.gr +28 -0
  107. package/runtime/unsafe/panic.md +14 -0
  108. package/runtime/unsafe/tags.md +32 -32
  109. package/runtime/unsafe/wasmf32.md +28 -28
  110. package/runtime/unsafe/wasmf64.md +28 -28
  111. package/runtime/unsafe/wasmi32.md +47 -47
  112. package/runtime/unsafe/wasmi64.md +50 -50
  113. package/runtime/utf8.gr +189 -0
  114. package/runtime/utf8.md +117 -0
  115. package/runtime/wasi.gr +4 -2
  116. package/runtime/wasi.md +147 -147
  117. package/set.gr +18 -11
  118. package/set.md +253 -247
  119. package/stack.gr +171 -2
  120. package/stack.md +371 -89
  121. package/string.gr +352 -557
  122. package/string.md +298 -255
  123. package/uint16.md +170 -170
  124. package/uint32.gr +25 -4
  125. package/uint32.md +249 -214
  126. package/uint64.gr +25 -5
  127. package/uint64.md +249 -214
  128. package/uint8.md +170 -170
  129. package/uri.gr +57 -53
  130. package/uri.md +88 -89
  131. package/wasi/file.gr +67 -59
  132. package/wasi/file.md +308 -308
  133. package/wasi/process.md +26 -26
  134. package/wasi/random.md +12 -12
  135. package/wasi/time.md +16 -16
  136. package/runtime/utils/printing.gr +0 -60
  137. package/runtime/utils/printing.md +0 -26
package/wasi/file.md CHANGED
@@ -509,7 +509,7 @@ Functions and constants included in the File module.
509
509
  ### File.**stdin**
510
510
 
511
511
  ```grain
512
- stdin : FileDescriptor
512
+ stdin: FileDescriptor
513
513
  ```
514
514
 
515
515
  The `FileDescriptor` for `stdin`.
@@ -517,7 +517,7 @@ The `FileDescriptor` for `stdin`.
517
517
  ### File.**stdout**
518
518
 
519
519
  ```grain
520
- stdout : FileDescriptor
520
+ stdout: FileDescriptor
521
521
  ```
522
522
 
523
523
  The `FileDescriptor` for `stdout`.
@@ -525,7 +525,7 @@ The `FileDescriptor` for `stdout`.
525
525
  ### File.**stderr**
526
526
 
527
527
  ```grain
528
- stderr : FileDescriptor
528
+ stderr: FileDescriptor
529
529
  ```
530
530
 
531
531
  The `FileDescriptor` for `stderr`.
@@ -533,7 +533,7 @@ The `FileDescriptor` for `stderr`.
533
533
  ### File.**pathOpen**
534
534
 
535
535
  ```grain
536
- pathOpen :
536
+ pathOpen:
537
537
  (dirFd: FileDescriptor, dirFlags: List<LookupFlag>, path: String,
538
538
  openFlags: List<OpenFlag>, rights: List<Rights>,
539
539
  rightsInheriting: List<Rights>, flags: List<FdFlag>) =>
@@ -544,26 +544,26 @@ Open a file or directory.
544
544
 
545
545
  Parameters:
546
546
 
547
- |param|type|description|
548
- |-----|----|-----------|
549
- |`dirFd`|`FileDescriptor`|The directory in which path resolution starts|
550
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
551
- |`path`|`String`|The path to the file or directory|
552
- |`openFlags`|`List<OpenFlag>`|Flags that decide how the path will be opened|
553
- |`rights`|`List<Rights>`|The rights that dictate what may be done with the returned file descriptor|
554
- |`rightsInheriting`|`List<Rights>`|The rights that dictate what may be done with file descriptors derived from this file descriptor|
555
- |`flags`|`List<FdFlag>`|Flags which affect read/write operations on this file descriptor|
547
+ | param | type | description |
548
+ | ------------------ | ------------------ | ------------------------------------------------------------------------------------------------ |
549
+ | `dirFd` | `FileDescriptor` | The directory in which path resolution starts |
550
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
551
+ | `path` | `String` | The path to the file or directory |
552
+ | `openFlags` | `List<OpenFlag>` | Flags that decide how the path will be opened |
553
+ | `rights` | `List<Rights>` | The rights that dictate what may be done with the returned file descriptor |
554
+ | `rightsInheriting` | `List<Rights>` | The rights that dictate what may be done with file descriptors derived from this file descriptor |
555
+ | `flags` | `List<FdFlag>` | Flags which affect read/write operations on this file descriptor |
556
556
 
557
557
  Returns:
558
558
 
559
- |type|description|
560
- |----|-----------|
561
- |`Result<FileDescriptor, Exception>`|`Ok(fd)` of the opened file or directory if successful or `Err(exception)` otherwise|
559
+ | type | description |
560
+ | ----------------------------------- | ------------------------------------------------------------------------------------ |
561
+ | `Result<FileDescriptor, Exception>` | `Ok(fd)` of the opened file or directory if successful or `Err(exception)` otherwise |
562
562
 
563
563
  ### File.**fdRead**
564
564
 
565
565
  ```grain
566
- fdRead :
566
+ fdRead:
567
567
  (fd: FileDescriptor, size: Number) => Result<(Bytes, Number), Exception>
568
568
  ```
569
569
 
@@ -571,21 +571,21 @@ Read from a file descriptor.
571
571
 
572
572
  Parameters:
573
573
 
574
- |param|type|description|
575
- |-----|----|-----------|
576
- |`fd`|`FileDescriptor`|The file descriptor to read from|
577
- |`size`|`Number`|The maximum number of bytes to read from the file descriptor|
574
+ | param | type | description |
575
+ | ------ | ---------------- | ------------------------------------------------------------ |
576
+ | `fd` | `FileDescriptor` | The file descriptor to read from |
577
+ | `size` | `Number` | The maximum number of bytes to read from the file descriptor |
578
578
 
579
579
  Returns:
580
580
 
581
- |type|description|
582
- |----|-----------|
583
- |`Result<(Bytes, Number), Exception>`|`Ok((contents, numBytes))` of bytes read and the number of bytes read if successful or `Err(exception)` otherwise|
581
+ | type | description |
582
+ | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
583
+ | `Result<(Bytes, Number), Exception>` | `Ok((contents, numBytes))` of bytes read and the number of bytes read if successful or `Err(exception)` otherwise |
584
584
 
585
585
  ### File.**fdPread**
586
586
 
587
587
  ```grain
588
- fdPread :
588
+ fdPread:
589
589
  (fd: FileDescriptor, offset: Int64, size: Number) =>
590
590
  Result<(Bytes, Number), Exception>
591
591
  ```
@@ -594,17 +594,17 @@ Read from a file descriptor without updating the file descriptor's offset.
594
594
 
595
595
  Parameters:
596
596
 
597
- |param|type|description|
598
- |-----|----|-----------|
599
- |`fd`|`FileDescriptor`|The file descriptor to read from|
600
- |`offset`|`Int64`|The position within the file to begin reading|
601
- |`size`|`Number`|The maximum number of bytes to read from the file descriptor|
597
+ | param | type | description |
598
+ | -------- | ---------------- | ------------------------------------------------------------ |
599
+ | `fd` | `FileDescriptor` | The file descriptor to read from |
600
+ | `offset` | `Int64` | The position within the file to begin reading |
601
+ | `size` | `Number` | The maximum number of bytes to read from the file descriptor |
602
602
 
603
603
  Returns:
604
604
 
605
- |type|description|
606
- |----|-----------|
607
- |`Result<(Bytes, Number), Exception>`|`Ok((contents, numBytes))` of bytes read and the number of bytes read if successful or `Err(exception)` otherwise|
605
+ | type | description |
606
+ | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
607
+ | `Result<(Bytes, Number), Exception>` | `Ok((contents, numBytes))` of bytes read and the number of bytes read if successful or `Err(exception)` otherwise |
608
608
 
609
609
  ### File.**fdPrestatGet**
610
610
 
@@ -614,48 +614,48 @@ No other changes yet.
614
614
  </details>
615
615
 
616
616
  ```grain
617
- fdPrestatGet : (fd: FileDescriptor) => Result<Prestat, Exception>
617
+ fdPrestatGet: (fd: FileDescriptor) => Result<Prestat, Exception>
618
618
  ```
619
619
 
620
620
  Get information about a preopened directory.
621
621
 
622
622
  Parameters:
623
623
 
624
- |param|type|description|
625
- |-----|----|-----------|
626
- |`fd`|`FileDescriptor`|The file descriptor to check|
624
+ | param | type | description |
625
+ | ----- | ---------------- | ---------------------------- |
626
+ | `fd` | `FileDescriptor` | The file descriptor to check |
627
627
 
628
628
  Returns:
629
629
 
630
- |type|description|
631
- |----|-----------|
632
- |`Result<Prestat, Exception>`|`Ok(Dir{prefix, fd})` if successful or `Err(exception)` otherwise|
630
+ | type | description |
631
+ | ---------------------------- | ----------------------------------------------------------------- |
632
+ | `Result<Prestat, Exception>` | `Ok(Dir{prefix, fd})` if successful or `Err(exception)` otherwise |
633
633
 
634
634
  ### File.**fdWrite**
635
635
 
636
636
  ```grain
637
- fdWrite : (fd: FileDescriptor, data: Bytes) => Result<Number, Exception>
637
+ fdWrite: (fd: FileDescriptor, data: Bytes) => Result<Number, Exception>
638
638
  ```
639
639
 
640
640
  Write to a file descriptor.
641
641
 
642
642
  Parameters:
643
643
 
644
- |param|type|description|
645
- |-----|----|-----------|
646
- |`fd`|`FileDescriptor`|The file descriptor to which data will be written|
647
- |`data`|`Bytes`|The data to be written|
644
+ | param | type | description |
645
+ | ------ | ---------------- | ------------------------------------------------- |
646
+ | `fd` | `FileDescriptor` | The file descriptor to which data will be written |
647
+ | `data` | `Bytes` | The data to be written |
648
648
 
649
649
  Returns:
650
650
 
651
- |type|description|
652
- |----|-----------|
653
- |`Result<Number, Exception>`|`Ok(numBytes)` of the number of bytes written if successful or `Err(Exception)` otherwise|
651
+ | type | description |
652
+ | --------------------------- | ----------------------------------------------------------------------------------------- |
653
+ | `Result<Number, Exception>` | `Ok(numBytes)` of the number of bytes written if successful or `Err(Exception)` otherwise |
654
654
 
655
655
  ### File.**fdPwrite**
656
656
 
657
657
  ```grain
658
- fdPwrite :
658
+ fdPwrite:
659
659
  (fd: FileDescriptor, data: Bytes, offset: Int64) =>
660
660
  Result<Number, Exception>
661
661
  ```
@@ -664,22 +664,22 @@ Write to a file descriptor without updating the file descriptor's offset.
664
664
 
665
665
  Parameters:
666
666
 
667
- |param|type|description|
668
- |-----|----|-----------|
669
- |`fd`|`FileDescriptor`|The file descriptor to which data will be written|
670
- |`data`|`Bytes`|The data to be written|
671
- |`offset`|`Int64`|The position within the file to begin writing|
667
+ | param | type | description |
668
+ | -------- | ---------------- | ------------------------------------------------- |
669
+ | `fd` | `FileDescriptor` | The file descriptor to which data will be written |
670
+ | `data` | `Bytes` | The data to be written |
671
+ | `offset` | `Int64` | The position within the file to begin writing |
672
672
 
673
673
  Returns:
674
674
 
675
- |type|description|
676
- |----|-----------|
677
- |`Result<Number, Exception>`|`Ok(numBytes)` of the number of bytes written if successful or `Err(exception)` otherwise|
675
+ | type | description |
676
+ | --------------------------- | ----------------------------------------------------------------------------------------- |
677
+ | `Result<Number, Exception>` | `Ok(numBytes)` of the number of bytes written if successful or `Err(exception)` otherwise |
678
678
 
679
679
  ### File.**fdAllocate**
680
680
 
681
681
  ```grain
682
- fdAllocate :
682
+ fdAllocate:
683
683
  (fd: FileDescriptor, offset: Int64, size: Int64) => Result<Void, Exception>
684
684
  ```
685
685
 
@@ -687,102 +687,102 @@ Allocate space within a file.
687
687
 
688
688
  Parameters:
689
689
 
690
- |param|type|description|
691
- |-----|----|-----------|
692
- |`fd`|`FileDescriptor`|The file descriptor in which space will be allocated|
693
- |`offset`|`Int64`|The position within the file to begin writing|
694
- |`size`|`Int64`|The number of bytes to allocate|
690
+ | param | type | description |
691
+ | -------- | ---------------- | ---------------------------------------------------- |
692
+ | `fd` | `FileDescriptor` | The file descriptor in which space will be allocated |
693
+ | `offset` | `Int64` | The position within the file to begin writing |
694
+ | `size` | `Int64` | The number of bytes to allocate |
695
695
 
696
696
  Returns:
697
697
 
698
- |type|description|
699
- |----|-----------|
700
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
698
+ | type | description |
699
+ | ------------------------- | ------------------------------------------------------ |
700
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
701
701
 
702
702
  ### File.**fdClose**
703
703
 
704
704
  ```grain
705
- fdClose : (fd: FileDescriptor) => Result<Void, Exception>
705
+ fdClose: (fd: FileDescriptor) => Result<Void, Exception>
706
706
  ```
707
707
 
708
708
  Close a file descriptor.
709
709
 
710
710
  Parameters:
711
711
 
712
- |param|type|description|
713
- |-----|----|-----------|
714
- |`fd`|`FileDescriptor`|The file descriptor to close|
712
+ | param | type | description |
713
+ | ----- | ---------------- | ---------------------------- |
714
+ | `fd` | `FileDescriptor` | The file descriptor to close |
715
715
 
716
716
  Returns:
717
717
 
718
- |type|description|
719
- |----|-----------|
720
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
718
+ | type | description |
719
+ | ------------------------- | ------------------------------------------------------ |
720
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
721
721
 
722
722
  ### File.**fdDatasync**
723
723
 
724
724
  ```grain
725
- fdDatasync : (fd: FileDescriptor) => Result<Void, Exception>
725
+ fdDatasync: (fd: FileDescriptor) => Result<Void, Exception>
726
726
  ```
727
727
 
728
728
  Synchronize the data of a file to disk.
729
729
 
730
730
  Parameters:
731
731
 
732
- |param|type|description|
733
- |-----|----|-----------|
734
- |`fd`|`FileDescriptor`|The file descriptor to synchronize|
732
+ | param | type | description |
733
+ | ----- | ---------------- | ---------------------------------- |
734
+ | `fd` | `FileDescriptor` | The file descriptor to synchronize |
735
735
 
736
736
  Returns:
737
737
 
738
- |type|description|
739
- |----|-----------|
740
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
738
+ | type | description |
739
+ | ------------------------- | ------------------------------------------------------ |
740
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
741
741
 
742
742
  ### File.**fdSync**
743
743
 
744
744
  ```grain
745
- fdSync : (fd: FileDescriptor) => Result<Void, Exception>
745
+ fdSync: (fd: FileDescriptor) => Result<Void, Exception>
746
746
  ```
747
747
 
748
748
  Synchronize the data and metadata of a file to disk.
749
749
 
750
750
  Parameters:
751
751
 
752
- |param|type|description|
753
- |-----|----|-----------|
754
- |`fd`|`FileDescriptor`|The file descriptor to synchronize|
752
+ | param | type | description |
753
+ | ----- | ---------------- | ---------------------------------- |
754
+ | `fd` | `FileDescriptor` | The file descriptor to synchronize |
755
755
 
756
756
  Returns:
757
757
 
758
- |type|description|
759
- |----|-----------|
760
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
758
+ | type | description |
759
+ | ------------------------- | ------------------------------------------------------ |
760
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
761
761
 
762
762
  ### File.**fdStats**
763
763
 
764
764
  ```grain
765
- fdStats : (fd: FileDescriptor) => Result<Stats, Exception>
765
+ fdStats: (fd: FileDescriptor) => Result<Stats, Exception>
766
766
  ```
767
767
 
768
768
  Retrieve information about a file descriptor.
769
769
 
770
770
  Parameters:
771
771
 
772
- |param|type|description|
773
- |-----|----|-----------|
774
- |`fd`|`FileDescriptor`|The file descriptor of which to retrieve information|
772
+ | param | type | description |
773
+ | ----- | ---------------- | ---------------------------------------------------- |
774
+ | `fd` | `FileDescriptor` | The file descriptor of which to retrieve information |
775
775
 
776
776
  Returns:
777
777
 
778
- |type|description|
779
- |----|-----------|
780
- |`Result<Stats, Exception>`|`Ok(stats)` of the `Stats` associated with the file descriptor if successful or `Err(exception)` otherwise|
778
+ | type | description |
779
+ | -------------------------- | ---------------------------------------------------------------------------------------------------------- |
780
+ | `Result<Stats, Exception>` | `Ok(stats)` of the `Stats` associated with the file descriptor if successful or `Err(exception)` otherwise |
781
781
 
782
782
  ### File.**fdSetFlags**
783
783
 
784
784
  ```grain
785
- fdSetFlags :
785
+ fdSetFlags:
786
786
  (fd: FileDescriptor, flags: List<FdFlag>) => Result<Void, Exception>
787
787
  ```
788
788
 
@@ -790,21 +790,21 @@ Update the flags associated with a file descriptor.
790
790
 
791
791
  Parameters:
792
792
 
793
- |param|type|description|
794
- |-----|----|-----------|
795
- |`fd`|`FileDescriptor`|The file descriptor to update flags|
796
- |`flags`|`List<FdFlag>`|The flags to apply to the file descriptor|
793
+ | param | type | description |
794
+ | ------- | ---------------- | ----------------------------------------- |
795
+ | `fd` | `FileDescriptor` | The file descriptor to update flags |
796
+ | `flags` | `List<FdFlag>` | The flags to apply to the file descriptor |
797
797
 
798
798
  Returns:
799
799
 
800
- |type|description|
801
- |----|-----------|
802
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
800
+ | type | description |
801
+ | ------------------------- | ------------------------------------------------------ |
802
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
803
803
 
804
804
  ### File.**fdSetRights**
805
805
 
806
806
  ```grain
807
- fdSetRights :
807
+ fdSetRights:
808
808
  (fd: FileDescriptor, rights: List<Rights>, rightsInheriting: List<Rights>) =>
809
809
  Result<Void, Exception>
810
810
  ```
@@ -813,63 +813,63 @@ Update the rights associated with a file descriptor.
813
813
 
814
814
  Parameters:
815
815
 
816
- |param|type|description|
817
- |-----|----|-----------|
818
- |`fd`|`FileDescriptor`|The file descriptor to update rights|
819
- |`rights`|`List<Rights>`|Rights to apply to the file descriptor|
820
- |`rightsInheriting`|`List<Rights>`|Inheriting rights to apply to the file descriptor|
816
+ | param | type | description |
817
+ | ------------------ | ---------------- | ------------------------------------------------- |
818
+ | `fd` | `FileDescriptor` | The file descriptor to update rights |
819
+ | `rights` | `List<Rights>` | Rights to apply to the file descriptor |
820
+ | `rightsInheriting` | `List<Rights>` | Inheriting rights to apply to the file descriptor |
821
821
 
822
822
  Returns:
823
823
 
824
- |type|description|
825
- |----|-----------|
826
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
824
+ | type | description |
825
+ | ------------------------- | ------------------------------------------------------ |
826
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
827
827
 
828
828
  ### File.**fdFilestats**
829
829
 
830
830
  ```grain
831
- fdFilestats : (fd: FileDescriptor) => Result<Filestats, Exception>
831
+ fdFilestats: (fd: FileDescriptor) => Result<Filestats, Exception>
832
832
  ```
833
833
 
834
834
  Retrieve information about a file.
835
835
 
836
836
  Parameters:
837
837
 
838
- |param|type|description|
839
- |-----|----|-----------|
840
- |`fd`|`FileDescriptor`|The file descriptor of the file to retrieve information|
838
+ | param | type | description |
839
+ | ----- | ---------------- | ------------------------------------------------------- |
840
+ | `fd` | `FileDescriptor` | The file descriptor of the file to retrieve information |
841
841
 
842
842
  Returns:
843
843
 
844
- |type|description|
845
- |----|-----------|
846
- |`Result<Filestats, Exception>`|`Ok(info)` of the `Filestats` associated with the file descriptor if successful or `Err(exception)` otherwise|
844
+ | type | description |
845
+ | ------------------------------ | ------------------------------------------------------------------------------------------------------------- |
846
+ | `Result<Filestats, Exception>` | `Ok(info)` of the `Filestats` associated with the file descriptor if successful or `Err(exception)` otherwise |
847
847
 
848
848
  ### File.**fdSetSize**
849
849
 
850
850
  ```grain
851
- fdSetSize : (fd: FileDescriptor, size: Int64) => Result<Void, Exception>
851
+ fdSetSize: (fd: FileDescriptor, size: Int64) => Result<Void, Exception>
852
852
  ```
853
853
 
854
854
  Set (truncate) the size of a file.
855
855
 
856
856
  Parameters:
857
857
 
858
- |param|type|description|
859
- |-----|----|-----------|
860
- |`fd`|`FileDescriptor`|The file descriptor of the file to truncate|
861
- |`size`|`Int64`|The number of bytes to retain in the file|
858
+ | param | type | description |
859
+ | ------ | ---------------- | ------------------------------------------- |
860
+ | `fd` | `FileDescriptor` | The file descriptor of the file to truncate |
861
+ | `size` | `Int64` | The number of bytes to retain in the file |
862
862
 
863
863
  Returns:
864
864
 
865
- |type|description|
866
- |----|-----------|
867
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
865
+ | type | description |
866
+ | ------------------------- | ------------------------------------------------------ |
867
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
868
868
 
869
869
  ### File.**fdSetAccessTime**
870
870
 
871
871
  ```grain
872
- fdSetAccessTime :
872
+ fdSetAccessTime:
873
873
  (fd: FileDescriptor, timestamp: Int64) => Result<Void, Exception>
874
874
  ```
875
875
 
@@ -877,41 +877,41 @@ Set the access (created) time of a file.
877
877
 
878
878
  Parameters:
879
879
 
880
- |param|type|description|
881
- |-----|----|-----------|
882
- |`fd`|`FileDescriptor`|The file descriptor of the file to update|
883
- |`timestamp`|`Int64`|The time to set|
880
+ | param | type | description |
881
+ | ----------- | ---------------- | ----------------------------------------- |
882
+ | `fd` | `FileDescriptor` | The file descriptor of the file to update |
883
+ | `timestamp` | `Int64` | The time to set |
884
884
 
885
885
  Returns:
886
886
 
887
- |type|description|
888
- |----|-----------|
889
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
887
+ | type | description |
888
+ | ------------------------- | ------------------------------------------------------ |
889
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
890
890
 
891
891
  ### File.**fdSetAccessTimeNow**
892
892
 
893
893
  ```grain
894
- fdSetAccessTimeNow : (fd: FileDescriptor) => Result<Void, Exception>
894
+ fdSetAccessTimeNow: (fd: FileDescriptor) => Result<Void, Exception>
895
895
  ```
896
896
 
897
897
  Set the access (created) time of a file to the current time.
898
898
 
899
899
  Parameters:
900
900
 
901
- |param|type|description|
902
- |-----|----|-----------|
903
- |`fd`|`FileDescriptor`|The file descriptor of the file to update|
901
+ | param | type | description |
902
+ | ----- | ---------------- | ----------------------------------------- |
903
+ | `fd` | `FileDescriptor` | The file descriptor of the file to update |
904
904
 
905
905
  Returns:
906
906
 
907
- |type|description|
908
- |----|-----------|
909
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
907
+ | type | description |
908
+ | ------------------------- | ------------------------------------------------------ |
909
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
910
910
 
911
911
  ### File.**fdSetModifiedTime**
912
912
 
913
913
  ```grain
914
- fdSetModifiedTime :
914
+ fdSetModifiedTime:
915
915
  (fd: FileDescriptor, timestamp: Int64) => Result<Void, Exception>
916
916
  ```
917
917
 
@@ -919,61 +919,61 @@ Set the modified time of a file.
919
919
 
920
920
  Parameters:
921
921
 
922
- |param|type|description|
923
- |-----|----|-----------|
924
- |`fd`|`FileDescriptor`|The file descriptor of the file to update|
925
- |`timestamp`|`Int64`|The time to set|
922
+ | param | type | description |
923
+ | ----------- | ---------------- | ----------------------------------------- |
924
+ | `fd` | `FileDescriptor` | The file descriptor of the file to update |
925
+ | `timestamp` | `Int64` | The time to set |
926
926
 
927
927
  Returns:
928
928
 
929
- |type|description|
930
- |----|-----------|
931
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
929
+ | type | description |
930
+ | ------------------------- | ------------------------------------------------------ |
931
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
932
932
 
933
933
  ### File.**fdSetModifiedTimeNow**
934
934
 
935
935
  ```grain
936
- fdSetModifiedTimeNow : (fd: FileDescriptor) => Result<Void, Exception>
936
+ fdSetModifiedTimeNow: (fd: FileDescriptor) => Result<Void, Exception>
937
937
  ```
938
938
 
939
939
  Set the modified time of a file to the current time.
940
940
 
941
941
  Parameters:
942
942
 
943
- |param|type|description|
944
- |-----|----|-----------|
945
- |`fd`|`FileDescriptor`|The file descriptor of the file to update|
943
+ | param | type | description |
944
+ | ----- | ---------------- | ----------------------------------------- |
945
+ | `fd` | `FileDescriptor` | The file descriptor of the file to update |
946
946
 
947
947
  Returns:
948
948
 
949
- |type|description|
950
- |----|-----------|
951
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
949
+ | type | description |
950
+ | ------------------------- | ------------------------------------------------------ |
951
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
952
952
 
953
953
  ### File.**fdReaddir**
954
954
 
955
955
  ```grain
956
- fdReaddir : (fd: FileDescriptor) => Result<Array<DirectoryEntry>, Exception>
956
+ fdReaddir: (fd: FileDescriptor) => Result<Array<DirectoryEntry>, Exception>
957
957
  ```
958
958
 
959
959
  Read the entires of a directory.
960
960
 
961
961
  Parameters:
962
962
 
963
- |param|type|description|
964
- |-----|----|-----------|
965
- |`fd`|`FileDescriptor`|The directory to read|
963
+ | param | type | description |
964
+ | ----- | ---------------- | --------------------- |
965
+ | `fd` | `FileDescriptor` | The directory to read |
966
966
 
967
967
  Returns:
968
968
 
969
- |type|description|
970
- |----|-----------|
971
- |`Result<Array<DirectoryEntry>, Exception>`|`Ok(dirEntries)` of an array of `DirectoryEntry` for each entry in the directory if successful or `Err(exception)` otherwise|
969
+ | type | description |
970
+ | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
971
+ | `Result<Array<DirectoryEntry>, Exception>` | `Ok(dirEntries)` of an array of `DirectoryEntry` for each entry in the directory if successful or `Err(exception)` otherwise |
972
972
 
973
973
  ### File.**fdRenumber**
974
974
 
975
975
  ```grain
976
- fdRenumber :
976
+ fdRenumber:
977
977
  (fromFd: FileDescriptor, toFd: FileDescriptor) => Result<Void, Exception>
978
978
  ```
979
979
 
@@ -981,21 +981,21 @@ Atomically replace a file descriptor by renumbering another file descriptor.
981
981
 
982
982
  Parameters:
983
983
 
984
- |param|type|description|
985
- |-----|----|-----------|
986
- |`fromFd`|`FileDescriptor`|The file descriptor to renumber|
987
- |`toFd`|`FileDescriptor`|The file descriptor to overwrite|
984
+ | param | type | description |
985
+ | -------- | ---------------- | -------------------------------- |
986
+ | `fromFd` | `FileDescriptor` | The file descriptor to renumber |
987
+ | `toFd` | `FileDescriptor` | The file descriptor to overwrite |
988
988
 
989
989
  Returns:
990
990
 
991
- |type|description|
992
- |----|-----------|
993
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
991
+ | type | description |
992
+ | ------------------------- | ------------------------------------------------------ |
993
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
994
994
 
995
995
  ### File.**fdSeek**
996
996
 
997
997
  ```grain
998
- fdSeek :
998
+ fdSeek:
999
999
  (fd: FileDescriptor, offset: Int64, whence: Whence) =>
1000
1000
  Result<Int64, Exception>
1001
1001
  ```
@@ -1004,42 +1004,42 @@ Update a file descriptor's offset.
1004
1004
 
1005
1005
  Parameters:
1006
1006
 
1007
- |param|type|description|
1008
- |-----|----|-----------|
1009
- |`fd`|`FileDescriptor`|The file descriptor to operate on|
1010
- |`offset`|`Int64`|The number of bytes to move the offset|
1011
- |`whence`|`Whence`|The location from which the offset is relative|
1007
+ | param | type | description |
1008
+ | -------- | ---------------- | ---------------------------------------------- |
1009
+ | `fd` | `FileDescriptor` | The file descriptor to operate on |
1010
+ | `offset` | `Int64` | The number of bytes to move the offset |
1011
+ | `whence` | `Whence` | The location from which the offset is relative |
1012
1012
 
1013
1013
  Returns:
1014
1014
 
1015
- |type|description|
1016
- |----|-----------|
1017
- |`Result<Int64, Exception>`|`Ok(offset)` of the new offset of the file descriptor, relative to the start of the file, if successful or `Err(exception)` otherwise|
1015
+ | type | description |
1016
+ | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
1017
+ | `Result<Int64, Exception>` | `Ok(offset)` of the new offset of the file descriptor, relative to the start of the file, if successful or `Err(exception)` otherwise |
1018
1018
 
1019
1019
  ### File.**fdTell**
1020
1020
 
1021
1021
  ```grain
1022
- fdTell : (fd: FileDescriptor) => Result<Int64, Exception>
1022
+ fdTell: (fd: FileDescriptor) => Result<Int64, Exception>
1023
1023
  ```
1024
1024
 
1025
1025
  Read a file descriptor's offset.
1026
1026
 
1027
1027
  Parameters:
1028
1028
 
1029
- |param|type|description|
1030
- |-----|----|-----------|
1031
- |`fd`|`FileDescriptor`|The file descriptor to read the offset|
1029
+ | param | type | description |
1030
+ | ----- | ---------------- | -------------------------------------- |
1031
+ | `fd` | `FileDescriptor` | The file descriptor to read the offset |
1032
1032
 
1033
1033
  Returns:
1034
1034
 
1035
- |type|description|
1036
- |----|-----------|
1037
- |`Result<Int64, Exception>`|`Ok(offset)` of the offset of the file descriptor, relative to the start of the file, if successful or `Err(exception)` otherwise|
1035
+ | type | description |
1036
+ | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1037
+ | `Result<Int64, Exception>` | `Ok(offset)` of the offset of the file descriptor, relative to the start of the file, if successful or `Err(exception)` otherwise |
1038
1038
 
1039
1039
  ### File.**pathCreateDirectory**
1040
1040
 
1041
1041
  ```grain
1042
- pathCreateDirectory :
1042
+ pathCreateDirectory:
1043
1043
  (fd: FileDescriptor, path: String) => Result<Void, Exception>
1044
1044
  ```
1045
1045
 
@@ -1047,21 +1047,21 @@ Create a directory.
1047
1047
 
1048
1048
  Parameters:
1049
1049
 
1050
- |param|type|description|
1051
- |-----|----|-----------|
1052
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1053
- |`path`|`String`|The path to the new directory|
1050
+ | param | type | description |
1051
+ | ------ | ---------------- | -------------------------------------------------------------------- |
1052
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1053
+ | `path` | `String` | The path to the new directory |
1054
1054
 
1055
1055
  Returns:
1056
1056
 
1057
- |type|description|
1058
- |----|-----------|
1059
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1057
+ | type | description |
1058
+ | ------------------------- | ------------------------------------------------------ |
1059
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1060
1060
 
1061
1061
  ### File.**pathFilestats**
1062
1062
 
1063
1063
  ```grain
1064
- pathFilestats :
1064
+ pathFilestats:
1065
1065
  (fd: FileDescriptor, dirFlags: List<LookupFlag>, path: String) =>
1066
1066
  Result<Filestats, Exception>
1067
1067
  ```
@@ -1070,22 +1070,22 @@ Retrieve information about a file.
1070
1070
 
1071
1071
  Parameters:
1072
1072
 
1073
- |param|type|description|
1074
- |-----|----|-----------|
1075
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1076
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
1077
- |`path`|`String`|The path to retrieve information about|
1073
+ | param | type | description |
1074
+ | ---------- | ------------------ | -------------------------------------------------------------------- |
1075
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1076
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
1077
+ | `path` | `String` | The path to retrieve information about |
1078
1078
 
1079
1079
  Returns:
1080
1080
 
1081
- |type|description|
1082
- |----|-----------|
1083
- |`Result<Filestats, Exception>`|`Ok(info)` of the `Filestats` associated with the file descriptor if successful or `Err(exception)` otherwise|
1081
+ | type | description |
1082
+ | ------------------------------ | ------------------------------------------------------------------------------------------------------------- |
1083
+ | `Result<Filestats, Exception>` | `Ok(info)` of the `Filestats` associated with the file descriptor if successful or `Err(exception)` otherwise |
1084
1084
 
1085
1085
  ### File.**pathSetAccessTime**
1086
1086
 
1087
1087
  ```grain
1088
- pathSetAccessTime :
1088
+ pathSetAccessTime:
1089
1089
  (fd: FileDescriptor, dirFlags: List<LookupFlag>, path: String,
1090
1090
  timestamp: Int64) => Result<Void, Exception>
1091
1091
  ```
@@ -1094,23 +1094,23 @@ Set the access (created) time of a file.
1094
1094
 
1095
1095
  Parameters:
1096
1096
 
1097
- |param|type|description|
1098
- |-----|----|-----------|
1099
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1100
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
1101
- |`path`|`String`|The path to set the time|
1102
- |`timestamp`|`Int64`|The time to set|
1097
+ | param | type | description |
1098
+ | ----------- | ------------------ | -------------------------------------------------------------------- |
1099
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1100
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
1101
+ | `path` | `String` | The path to set the time |
1102
+ | `timestamp` | `Int64` | The time to set |
1103
1103
 
1104
1104
  Returns:
1105
1105
 
1106
- |type|description|
1107
- |----|-----------|
1108
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1106
+ | type | description |
1107
+ | ------------------------- | ------------------------------------------------------ |
1108
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1109
1109
 
1110
1110
  ### File.**pathSetAccessTimeNow**
1111
1111
 
1112
1112
  ```grain
1113
- pathSetAccessTimeNow :
1113
+ pathSetAccessTimeNow:
1114
1114
  (fd: FileDescriptor, dirFlags: List<LookupFlag>, path: String) =>
1115
1115
  Result<Void, Exception>
1116
1116
  ```
@@ -1119,22 +1119,22 @@ Set the access (created) time of a file to the current time.
1119
1119
 
1120
1120
  Parameters:
1121
1121
 
1122
- |param|type|description|
1123
- |-----|----|-----------|
1124
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1125
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
1126
- |`path`|`String`|The path to set the time|
1122
+ | param | type | description |
1123
+ | ---------- | ------------------ | -------------------------------------------------------------------- |
1124
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1125
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
1126
+ | `path` | `String` | The path to set the time |
1127
1127
 
1128
1128
  Returns:
1129
1129
 
1130
- |type|description|
1131
- |----|-----------|
1132
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1130
+ | type | description |
1131
+ | ------------------------- | ------------------------------------------------------ |
1132
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1133
1133
 
1134
1134
  ### File.**pathSetModifiedTime**
1135
1135
 
1136
1136
  ```grain
1137
- pathSetModifiedTime :
1137
+ pathSetModifiedTime:
1138
1138
  (fd: FileDescriptor, dirFlags: List<LookupFlag>, path: String,
1139
1139
  timestamp: Int64) => Result<Void, Exception>
1140
1140
  ```
@@ -1143,23 +1143,23 @@ Set the modified time of a file.
1143
1143
 
1144
1144
  Parameters:
1145
1145
 
1146
- |param|type|description|
1147
- |-----|----|-----------|
1148
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1149
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
1150
- |`path`|`String`|The path to set the time|
1151
- |`timestamp`|`Int64`|The time to set|
1146
+ | param | type | description |
1147
+ | ----------- | ------------------ | -------------------------------------------------------------------- |
1148
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1149
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
1150
+ | `path` | `String` | The path to set the time |
1151
+ | `timestamp` | `Int64` | The time to set |
1152
1152
 
1153
1153
  Returns:
1154
1154
 
1155
- |type|description|
1156
- |----|-----------|
1157
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1155
+ | type | description |
1156
+ | ------------------------- | ------------------------------------------------------ |
1157
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1158
1158
 
1159
1159
  ### File.**pathSetModifiedTimeNow**
1160
1160
 
1161
1161
  ```grain
1162
- pathSetModifiedTimeNow :
1162
+ pathSetModifiedTimeNow:
1163
1163
  (fd: FileDescriptor, dirFlags: List<LookupFlag>, path: String) =>
1164
1164
  Result<Void, Exception>
1165
1165
  ```
@@ -1168,22 +1168,22 @@ Set the modified time of a file to the current time.
1168
1168
 
1169
1169
  Parameters:
1170
1170
 
1171
- |param|type|description|
1172
- |-----|----|-----------|
1173
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1174
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
1175
- |`path`|`String`|The path to set the time|
1171
+ | param | type | description |
1172
+ | ---------- | ------------------ | -------------------------------------------------------------------- |
1173
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1174
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
1175
+ | `path` | `String` | The path to set the time |
1176
1176
 
1177
1177
  Returns:
1178
1178
 
1179
- |type|description|
1180
- |----|-----------|
1181
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1179
+ | type | description |
1180
+ | ------------------------- | ------------------------------------------------------ |
1181
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1182
1182
 
1183
1183
  ### File.**pathLink**
1184
1184
 
1185
1185
  ```grain
1186
- pathLink :
1186
+ pathLink:
1187
1187
  (sourceFd: FileDescriptor, dirFlags: List<LookupFlag>, sourcePath:
1188
1188
  String, targetFd: FileDescriptor, targetPath: String) =>
1189
1189
  Result<Void, Exception>
@@ -1193,24 +1193,24 @@ Create a hard link.
1193
1193
 
1194
1194
  Parameters:
1195
1195
 
1196
- |param|type|description|
1197
- |-----|----|-----------|
1198
- |`sourceFd`|`FileDescriptor`|The file descriptor of the directory in which the source path resolution starts|
1199
- |`dirFlags`|`List<LookupFlag>`|Flags which affect path resolution|
1200
- |`sourcePath`|`String`|The path to the source of the link|
1201
- |`targetFd`|`FileDescriptor`|The file descriptor of the directory in which the target path resolution starts|
1202
- |`targetPath`|`String`|The path to the target of the link|
1196
+ | param | type | description |
1197
+ | ------------ | ------------------ | ------------------------------------------------------------------------------- |
1198
+ | `sourceFd` | `FileDescriptor` | The file descriptor of the directory in which the source path resolution starts |
1199
+ | `dirFlags` | `List<LookupFlag>` | Flags which affect path resolution |
1200
+ | `sourcePath` | `String` | The path to the source of the link |
1201
+ | `targetFd` | `FileDescriptor` | The file descriptor of the directory in which the target path resolution starts |
1202
+ | `targetPath` | `String` | The path to the target of the link |
1203
1203
 
1204
1204
  Returns:
1205
1205
 
1206
- |type|description|
1207
- |----|-----------|
1208
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1206
+ | type | description |
1207
+ | ------------------------- | ------------------------------------------------------ |
1208
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1209
1209
 
1210
1210
  ### File.**pathSymlink**
1211
1211
 
1212
1212
  ```grain
1213
- pathSymlink :
1213
+ pathSymlink:
1214
1214
  (fd: FileDescriptor, sourcePath: String, targetPath: String) =>
1215
1215
  Result<Void, Exception>
1216
1216
  ```
@@ -1219,43 +1219,43 @@ Create a symlink.
1219
1219
 
1220
1220
  Parameters:
1221
1221
 
1222
- |param|type|description|
1223
- |-----|----|-----------|
1224
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1225
- |`sourcePath`|`String`|The path to the source of the link|
1226
- |`targetPath`|`String`|The path to the target of the link|
1222
+ | param | type | description |
1223
+ | ------------ | ---------------- | -------------------------------------------------------------------- |
1224
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1225
+ | `sourcePath` | `String` | The path to the source of the link |
1226
+ | `targetPath` | `String` | The path to the target of the link |
1227
1227
 
1228
1228
  Returns:
1229
1229
 
1230
- |type|description|
1231
- |----|-----------|
1232
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1230
+ | type | description |
1231
+ | ------------------------- | ------------------------------------------------------ |
1232
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1233
1233
 
1234
1234
  ### File.**pathUnlink**
1235
1235
 
1236
1236
  ```grain
1237
- pathUnlink : (fd: FileDescriptor, path: String) => Result<Void, Exception>
1237
+ pathUnlink: (fd: FileDescriptor, path: String) => Result<Void, Exception>
1238
1238
  ```
1239
1239
 
1240
1240
  Unlink a file.
1241
1241
 
1242
1242
  Parameters:
1243
1243
 
1244
- |param|type|description|
1245
- |-----|----|-----------|
1246
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1247
- |`path`|`String`|The path of the file to unlink|
1244
+ | param | type | description |
1245
+ | ------ | ---------------- | -------------------------------------------------------------------- |
1246
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1247
+ | `path` | `String` | The path of the file to unlink |
1248
1248
 
1249
1249
  Returns:
1250
1250
 
1251
- |type|description|
1252
- |----|-----------|
1253
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1251
+ | type | description |
1252
+ | ------------------------- | ------------------------------------------------------ |
1253
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1254
1254
 
1255
1255
  ### File.**pathReadlink**
1256
1256
 
1257
1257
  ```grain
1258
- pathReadlink :
1258
+ pathReadlink:
1259
1259
  (fd: FileDescriptor, path: String, size: Number) =>
1260
1260
  Result<(String, Number), Exception>
1261
1261
  ```
@@ -1264,22 +1264,22 @@ Read the contents of a symbolic link.
1264
1264
 
1265
1265
  Parameters:
1266
1266
 
1267
- |param|type|description|
1268
- |-----|----|-----------|
1269
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1270
- |`path`|`String`|The path to the symlink|
1271
- |`size`|`Number`|The number of bytes to read|
1267
+ | param | type | description |
1268
+ | ------ | ---------------- | -------------------------------------------------------------------- |
1269
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1270
+ | `path` | `String` | The path to the symlink |
1271
+ | `size` | `Number` | The number of bytes to read |
1272
1272
 
1273
1273
  Returns:
1274
1274
 
1275
- |type|description|
1276
- |----|-----------|
1277
- |`Result<(String, Number), Exception>`|`Ok((contents, numBytes))` of the bytes read and the number of bytes read if successful or `Err(exception)` otherwise|
1275
+ | type | description |
1276
+ | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
1277
+ | `Result<(String, Number), Exception>` | `Ok((contents, numBytes))` of the bytes read and the number of bytes read if successful or `Err(exception)` otherwise |
1278
1278
 
1279
1279
  ### File.**pathRemoveDirectory**
1280
1280
 
1281
1281
  ```grain
1282
- pathRemoveDirectory :
1282
+ pathRemoveDirectory:
1283
1283
  (fd: FileDescriptor, path: String) => Result<Void, Exception>
1284
1284
  ```
1285
1285
 
@@ -1287,21 +1287,21 @@ Remove a directory.
1287
1287
 
1288
1288
  Parameters:
1289
1289
 
1290
- |param|type|description|
1291
- |-----|----|-----------|
1292
- |`fd`|`FileDescriptor`|The file descriptor of the directory in which path resolution starts|
1293
- |`path`|`String`|The path to the directory to remove|
1290
+ | param | type | description |
1291
+ | ------ | ---------------- | -------------------------------------------------------------------- |
1292
+ | `fd` | `FileDescriptor` | The file descriptor of the directory in which path resolution starts |
1293
+ | `path` | `String` | The path to the directory to remove |
1294
1294
 
1295
1295
  Returns:
1296
1296
 
1297
- |type|description|
1298
- |----|-----------|
1299
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1297
+ | type | description |
1298
+ | ------------------------- | ------------------------------------------------------ |
1299
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1300
1300
 
1301
1301
  ### File.**pathRename**
1302
1302
 
1303
1303
  ```grain
1304
- pathRename :
1304
+ pathRename:
1305
1305
  (sourceFd: FileDescriptor, sourcePath: String, targetFd: FileDescriptor,
1306
1306
  targetPath: String) => Result<Void, Exception>
1307
1307
  ```
@@ -1310,18 +1310,18 @@ Rename a file or directory.
1310
1310
 
1311
1311
  Parameters:
1312
1312
 
1313
- |param|type|description|
1314
- |-----|----|-----------|
1315
- |`sourceFd`|`FileDescriptor`|The file descriptor of the directory in which the source path resolution starts|
1316
- |`sourcePath`|`String`|The path of the file to rename|
1317
- |`targetFd`|`FileDescriptor`|The file descriptor of the directory in which the target path resolution starts|
1318
- |`targetPath`|`String`|The new path of the file|
1313
+ | param | type | description |
1314
+ | ------------ | ---------------- | ------------------------------------------------------------------------------- |
1315
+ | `sourceFd` | `FileDescriptor` | The file descriptor of the directory in which the source path resolution starts |
1316
+ | `sourcePath` | `String` | The path of the file to rename |
1317
+ | `targetFd` | `FileDescriptor` | The file descriptor of the directory in which the target path resolution starts |
1318
+ | `targetPath` | `String` | The new path of the file |
1319
1319
 
1320
1320
  Returns:
1321
1321
 
1322
- |type|description|
1323
- |----|-----------|
1324
- |`Result<Void, Exception>`|`Ok(void)` if successful or `Err(exception)` otherwise|
1322
+ | type | description |
1323
+ | ------------------------- | ------------------------------------------------------ |
1324
+ | `Result<Void, Exception>` | `Ok(void)` if successful or `Err(exception)` otherwise |
1325
1325
 
1326
1326
  ### File.**open**
1327
1327
 
@@ -1331,7 +1331,7 @@ No other changes yet.
1331
1331
  </details>
1332
1332
 
1333
1333
  ```grain
1334
- open :
1334
+ open:
1335
1335
  (path: String, openFlags: List<OpenFlag>, rights: List<Rights>,
1336
1336
  rightsInheriting: List<Rights>, flags: List<FdFlag>) =>
1337
1337
  Result<FileDescriptor, Exception>
@@ -1341,17 +1341,17 @@ Similar to `pathOpen`, but resolves the path relative to preopened directories.
1341
1341
 
1342
1342
  Parameters:
1343
1343
 
1344
- |param|type|description|
1345
- |-----|----|-----------|
1346
- |`path`|`String`|The path to the file or directory|
1347
- |`openFlags`|`List<OpenFlag>`|Flags that decide how the path will be opened|
1348
- |`rights`|`List<Rights>`|The rights that dictate what may be done with the returned file descriptor|
1349
- |`rightsInheriting`|`List<Rights>`|The rights that dictate what may be done with file descriptors derived from this file descriptor|
1350
- |`flags`|`List<FdFlag>`|Flags which affect read/write operations on this file descriptor|
1344
+ | param | type | description |
1345
+ | ------------------ | ---------------- | ------------------------------------------------------------------------------------------------ |
1346
+ | `path` | `String` | The path to the file or directory |
1347
+ | `openFlags` | `List<OpenFlag>` | Flags that decide how the path will be opened |
1348
+ | `rights` | `List<Rights>` | The rights that dictate what may be done with the returned file descriptor |
1349
+ | `rightsInheriting` | `List<Rights>` | The rights that dictate what may be done with file descriptors derived from this file descriptor |
1350
+ | `flags` | `List<FdFlag>` | Flags which affect read/write operations on this file descriptor |
1351
1351
 
1352
1352
  Returns:
1353
1353
 
1354
- |type|description|
1355
- |----|-----------|
1356
- |`Result<FileDescriptor, Exception>`|`Ok(fd)` of the opened file or directory if successful or `Err(exception)` otherwise|
1354
+ | type | description |
1355
+ | ----------------------------------- | ------------------------------------------------------------------------------------ |
1356
+ | `Result<FileDescriptor, Exception>` | `Ok(fd)` of the opened file or directory if successful or `Err(exception)` otherwise |
1357
1357