{"id":13580494,"url":"https://github.com/germangb/mini-fs","last_synced_at":"2026-04-09T14:02:02.604Z","repository":{"id":57638731,"uuid":"183523764","full_name":"germangb/mini-fs","owner":"germangb","description":"Extensible app filesystem library.","archived":false,"fork":false,"pushed_at":"2020-02-06T20:47:39.000Z","size":3075,"stargazers_count":32,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-09T02:05:32.529Z","etag":null,"topics":["rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/germangb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-25T23:31:39.000Z","updated_at":"2024-08-19T07:49:18.000Z","dependencies_parsed_at":"2022-08-30T07:42:57.239Z","dependency_job_id":null,"html_url":"https://github.com/germangb/mini-fs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/germangb%2Fmini-fs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/germangb%2Fmini-fs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/germangb%2Fmini-fs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/germangb%2Fmini-fs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/germangb","download_url":"https://codeload.github.com/germangb/mini-fs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247426052,"owners_count":20937060,"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":["rust"],"created_at":"2024-08-01T15:01:52.370Z","updated_at":"2025-12-12T13:34:26.255Z","avatar_url":"https://github.com/germangb.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# mini-fs\n\n[![Cargo package](https://img.shields.io/crates/v/mini-fs.svg?style=flat-square)](https://crates.io/crates/mini-fs)\n[![Build Status](https://img.shields.io/travis/germangb/mini-fs/master.svg?style=flat-square)](https://travis-ci.org/germangb/mini-fs)\n[![docs.rs docs](https://docs.rs/mini-fs/badge.svg?style=flat-square)](https://docs.rs/mini-fs)\n[![Master docs](https://img.shields.io/badge/docs-master-blue.svg?style=flat-square)](https://germangb.github.io/mini-fs/)\n\n**mini-fs** is an extensible virtual filesystem for the application layer.\n\nSupports reading from both the native filesystem, as well as Tar \u0026 Zip archives.\n\n```toml\n[dependencies]\nmini-fs = \"0.2\"\n```\n\nExample:\n\n```rust\nuse mini_fs::prelude::*;\nuse mini_fs::{LocalFs, TarFs, MiniFs};\n\n// Declare some file systems.\nlet local = LocalFs::pwd()?;\nlet tar = TarFs::open(\"archive.tar.gz\")?;\n\n// Mount them.\nlet mut fs = MiniFs::new()\n    .mount(\"/data\", local)\n    .mount(\"/archived\", tar);\n\n// To open (read) files:\nlet file = fs.open(\"/data/example.gif\")?;\n```\n\n## Overlay filesystem\n\nYou can merge multiple file systems so they share the same mount point using a tuple.\n\n```rust\nlet a = LocalFs::new(\"data/\");\n// |- example.txt\n\nlet b = TarFs::open(\"archive.tar.gz\")?;\n// |- example.txt\n// |- hello.txt\n\nlet files = MiniFs::new().mount(\"/files\", (a, b));\n\nassert!(files.open(\"/files/example.txt\").is_ok()); // this \"example.txt\" is from \"a\"\nassert!(files.open(\"/files/hello.txt\").is_ok());\n```\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2019 German Gomez Bajo\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgermangb%2Fmini-fs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgermangb%2Fmini-fs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgermangb%2Fmini-fs/lists"}