From 3595dce08f5fda04dd8f65273fdd3b6ed6b6af4a Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Wed, 8 May 2024 09:46:33 +0200 Subject: [PATCH 1/4] wip --- src/files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/files.md b/src/files.md index 92176ed1..3234b824 100644 --- a/src/files.md +++ b/src/files.md @@ -3,7 +3,7 @@ ## Virtual File System (VFS) The primary way to access files within your node is through the [VFS API](./apis/vfs.md). -The VFS API follows std::fs closely, adding some capabilities checks on paths and some combinatory actions. +The VFS API follows [std::fs](https://doc.rust-lang.org/std/fs/index.html) closely, adding some capabilities checks on paths and some combinatory actions. VFS files exist in the "/vfs" folder within your home node, and files are grouped by `package_id`. For example, part of the VFS might look like: From fd50bf0a5219a0d7d6a51281ed18374fe4947742 Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Wed, 8 May 2024 12:41:21 +0200 Subject: [PATCH 2/4] add links --- src/files.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/files.md b/src/files.md index 3234b824..35e88fb1 100644 --- a/src/files.md +++ b/src/files.md @@ -5,7 +5,7 @@ The primary way to access files within your node is through the [VFS API](./apis/vfs.md). The VFS API follows [std::fs](https://doc.rust-lang.org/std/fs/index.html) closely, adding some capabilities checks on paths and some combinatory actions. -VFS files exist in the "/vfs" folder within your home node, and files are grouped by `package_id`. +VFS files exist in the "/vfs" folder within your home node, and files are grouped by [`package_id`](https://docs.rs/kinode_process_lib/latest/kinode_process_lib/struct.PackageId.html). For example, part of the VFS might look like: ```text @@ -33,7 +33,7 @@ For example, part of the VFS might look like: ## Usage -To access files in the VFS, you need to create or open a [drive](./apis/vfs.md#drives), this can be done with the function `create_drive` from the [standard library](./process_stdlib/overview.md): +To access files in the VFS, you need to create or open a [drive](./apis/vfs.md#drives), this can be done with the function [`create_drive`](https://docs.rs/kinode_process_lib/latest/kinode_process_lib/vfs/file/fn.create_drive.html) from the [standard library](./process_stdlib/overview.md): ```rust let drive_path: String = create_drive(our.package_id(), "drive_name")?; From 576c7fc326b8c237a2121cdc32245b84821c6018 Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Thu, 9 May 2024 08:36:17 +0200 Subject: [PATCH 3/4] remove redundant refs --- src/files.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/files.md b/src/files.md index 35e88fb1..9267142f 100644 --- a/src/files.md +++ b/src/files.md @@ -43,8 +43,3 @@ let test_file = create_file(&format("{}/test.txt", &drive_path))?; let text = b"hello world!" file.write(&text)?; ``` - -## References - -- [VFS API](./apis/vfs.md) -- [std::fs API](https://doc.rust-lang.org/std/fs/index.html) From c9c50c78bcb3591964a40ff7fb5144ee0c6ea6c4 Mon Sep 17 00:00:00 2001 From: jurij-jukic Date: Fri, 10 May 2024 09:11:54 +0200 Subject: [PATCH 4/4] remove mention of combinatroy actions --- src/files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/files.md b/src/files.md index 9267142f..c0ed9d20 100644 --- a/src/files.md +++ b/src/files.md @@ -3,7 +3,7 @@ ## Virtual File System (VFS) The primary way to access files within your node is through the [VFS API](./apis/vfs.md). -The VFS API follows [std::fs](https://doc.rust-lang.org/std/fs/index.html) closely, adding some capabilities checks on paths and some combinatory actions. +The VFS API follows [std::fs](https://doc.rust-lang.org/std/fs/index.html) closely, while also adding some capabilities checks on paths. VFS files exist in the "/vfs" folder within your home node, and files are grouped by [`package_id`](https://docs.rs/kinode_process_lib/latest/kinode_process_lib/struct.PackageId.html). For example, part of the VFS might look like: