{"id":29066896,"url":"https://github.com/rhaiscript/rhai-fs","last_synced_at":"2025-06-27T10:08:51.659Z","repository":{"id":61271726,"uuid":"545247731","full_name":"rhaiscript/rhai-fs","owner":"rhaiscript","description":"Provides filesystem access for the Rhai scripting language.","archived":false,"fork":false,"pushed_at":"2023-10-25T09:20:17.000Z","size":62,"stargazers_count":10,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-21T14:42:40.007Z","etag":null,"topics":["filesystem","lib","rhai","rhai-fs","scripting-language"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rhaiscript.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-04T03:08:14.000Z","updated_at":"2023-11-02T17:51:53.000Z","dependencies_parsed_at":"2023-01-23T14:30:09.245Z","dependency_job_id":"3bd96896-e032-4384-b305-aae6c79c8b29","html_url":"https://github.com/rhaiscript/rhai-fs","commit_stats":{"total_commits":35,"total_committers":3,"mean_commits":"11.666666666666666","dds":"0.34285714285714286","last_synced_commit":"8a706cf57dac45de00df4f067d561025412453cf"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rhaiscript/rhai-fs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhaiscript%2Frhai-fs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhaiscript%2Frhai-fs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhaiscript%2Frhai-fs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhaiscript%2Frhai-fs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhaiscript","download_url":"https://codeload.github.com/rhaiscript/rhai-fs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhaiscript%2Frhai-fs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262235784,"owners_count":23279567,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["filesystem","lib","rhai","rhai-fs","scripting-language"],"created_at":"2025-06-27T10:08:50.905Z","updated_at":"2025-06-27T10:08:51.648Z","avatar_url":"https://github.com/rhaiscript.png","language":"Rust","readme":"# About `rhai-fs`\n\n[![License](https://img.shields.io/crates/l/rhai-fs)](https://github.com/license/rhaiscript/rhai-fs)\n[![crates.io](https://img.shields.io/crates/v/rhai-fs?logo=rust)](https://crates.io/crates/rhai-fs/)\n[![crates.io](https://img.shields.io/crates/d/rhai-fs?logo=rust)](https://crates.io/crates/rhai-fs/)\n[![API Docs](https://docs.rs/rhai-fs/badge.svg?logo=docs-rs)](https://docs.rs/rhai-fs/)\n\nThis crate provides filesystem access for the [Rhai] scripting language.\n\n## Usage\n\n### `Cargo.toml`\n\n```toml\n[dependencies]\nrhai-fs = \"0.1.2\"\n```\n\n### [Rhai] script\n\n```js\n// Create a file or open and truncate if file is already created\nlet file = open_file(\"example.txt\");\nlet blob_buf = file.read_blob();\nprint(\"file contents: \" + blob_buf);\nblob_buf.write_utf8(0..=0x20, \"foobar\");\nprint(\"new file contents: \" + blob_buf);\nfile.write(blob_buf);\n```\n\n### Rust source\n\n```rust\nuse rhai::{Engine, EvalAltResult};\nuse rhai::packages::Package;\nuse rhai_fs::FilesystemPackage;\n\nfn main() -\u003e Result\u003c(), Box\u003cEvalAltResult\u003e\u003e {\n    // Create Rhai scripting engine\n    let mut engine = Engine::new();\n\n    // Create filesystem package and add the package into the engine\n    let package = FilesystemPackage::new();\n    package.register_into_engine(\u0026mut engine);\n\n    // Print the contents of the file `Cargo.toml`.\n    let contents = engine.eval::\u003cString\u003e(r#\"open_file(\"Cargo.toml\", \"r\").read_string()\"#)?;\n    println!(\"{}\", contents);\n\n    Ok(())\n}\n```\n\n## Features\n\n|  Feature   | Default  | Description                                          |\n| :--------: | :------: | ---------------------------------------------------- |\n| `no_index` | disabled | Enables support for `no_index` builds of [Rhai]      |\n|   `sync`   | disabled | Enables support for `sync` builds of [Rhai]          |\n| `metadata` | disabled | Enables support for generating package documentation |\n\n[Rhai]: https://rhai.rs\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhaiscript%2Frhai-fs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhaiscript%2Frhai-fs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhaiscript%2Frhai-fs/lists"}