Skip to content

chore: Clarify FS Plugin Rust Side Exposure #2590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

chore: Clarify FS Plugin Rust Side Exposure #2590

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f12ef58
clarify rust side exposure
tweidinger Aug 26, 2024
8a63c11
add mention of partial api exposure
tweidinger Aug 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/content/docs/plugin/file-system.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ Install the fs plugin to get started.

The fs plugin is available in both JavaScript and Rust.

:::note[Rust Exposure]

The exposed API on the Rust side is only intended to manipulate the [Scope](#scopes) of the plugin but
does not expose any functional API to access the file system. Please use [`tokio::fs`](https://docs.rs/tokio/latest/tokio/fs/index.html) or the
[`std::fs`](https://doc.rust-lang.org/std/fs/index.html) for accessing the file system.

:::

<Tabs>
<TabItem label="JavaScript" >

Expand Down
Loading