Adds Missing Documentation for WasiContext

Dheatly23 · Jan 16, 2025 · e0093c7 · e0093c7
1 parent 6aaeab4
commit e0093c7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/doc/WasiContext.md b/doc/WasiContext.md
@@ -110,3 +110,11 @@ Writes file content.
 Accepts `String` and all `Pool*` data type, except `PoolStringArray`.
 File will be appended with zeros if needed.
 Returns `true` if succeed.
+
+### `null|Array file_read_struct(String path, String format, [int offset, bool follow_symlink])`
+
+Reads file content as structured data. Similar to `WasmInstance.read_struct`.
+
+### `bool file_write_struct(String path, String format, Array arr, [int offset, bool truncate, bool follow_symlink])`
+
+Writes file content as structured data. Similar to `WasmInstance.write_struct`.
diff --git a/src/wasi_ctx/mod.rs b/src/wasi_ctx/mod.rs
@@ -818,17 +818,17 @@ impl WasiContext {
     /// Arguments:
     /// - `path` : Absolute path to file.
     /// - `format` : String defining the structure format.
-    /// - `offset` : Offset from start of file.
     /// - `arr` : Structured data array.
+    /// - `offset` : Offset from start of file.
     /// - `truncate` : If `true`, truncate file before writing.
     /// - `follow_symlink` : If `true`, follow symbolic links.
     #[func]
     fn file_write_struct(
         &self,
         path: GString,
         format: GString,
-        offset: Variant,
         arr: VariantArray,
+        offset: Variant,
         truncate: Variant,
         follow_symlink: Variant,
     ) -> Variant {