fsquirrel
| Crates.io | fsquirrel |
| lib.rs | fsquirrel |
| version | 0.1.3 |
| created_at | 2025-06-20 22:12:25.613681+00 |
| updated_at | 2025-07-18 18:09:59.141324+00 |
| description | fsquirrel is a cross-platform get/set extended file attributes |
| homepage | |
| repository | https://github.com/finnbear/fsquirrel/ |
| max_upload_size | |
| id | 1720331 |
| size | 20,823 |
Finn Bear (finnbear)
documentation
README
fsquirrel
A small library for stashing custom extended attribute key-value pairs into file metadata, avoiding the need for sidecar files.
These attributes are may be preserved when files are copied to a compatible file system, but are always discarded in cases such as uploading to the internet. More specifically:
- On Windows and MacOS,
fs::copycan preserve them. - On Linux, only
/usr/bin/cp --preserve=xattrcan preserve them.
Platform support
On Unix (Android, Linux, MacOS, FreeBSD, NetBSD), this is a wrapper around xattr, hard-coded to the user. namespace.
On Windows, this uses NTFS Alternate Data Streams. It's not compatible with OS/2 exended attributes.
Features
- Get 🕳️🌰🐿️
- Set 🐿️💨 🌰
- Remove 🌰🐿️💨 🕳️
- List 🥜🌰🥔
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.