https://github.com/rafalh/rust-fatfs

A FAT filesystem library implemented in Rust.
https://github.com/rafalh/rust-fatfs

fat fat12 fat16 fat32 filesystem-library rust

Last synced: 3 days ago
JSON representation

A FAT filesystem library implemented in Rust.

• Host: GitHub
• URL: https://github.com/rafalh/rust-fatfs
• Owner: rafalh
• License: mit
• Created: 2017-09-24T01:14:45.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T18:46:43.000Z (4 months ago)
• Last Synced: 2024-10-13T21:46:22.241Z (2 months ago)
• Topics: fat, fat12, fat16, fat32, filesystem-library, rust
• Language: Rust
• Homepage:
• Size: 630 KB
• Stars: 292
• Watchers: 10
• Forks: 53
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Rust FAT FS

===========

[![CI Status](https://github.com/rafalh/rust-fatfs/actions/workflows/ci.yml/badge.svg)](https://github.com/rafalh/rust-fatfs/actions/workflows/ci.yml)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)

[![crates.io](https://img.shields.io/crates/v/fatfs)](https://crates.io/crates/fatfs)

[![Documentation](https://docs.rs/fatfs/badge.svg)](https://docs.rs/fatfs)

[![Minimum rustc version](https://img.shields.io/badge/rustc-1.65+-yellow.svg)](https://blog.rust-lang.org/2022/11/03/Rust-1.65.0.html)

A FAT filesystem library implemented in Rust.

Features:

* read/write file using standard Read/Write traits

* read directory contents

* create/remove file or directory

* rename/move file or directory

* read/write file timestamps (updated automatically if `chrono` feature is enabled)

* format volume

* FAT12, FAT16, FAT32 compatibility

* LFN (Long File Names) extension is supported

* Basic no_std environment support

* logging configurable at compile time using cargo features

Usage

-----

Add this to your `Cargo.toml`:

    [dependencies]

    fatfs = "0.4"

You can start using the `fatfs` library now:

    let img_file = File::open("fat.img")?;

    let fs = fatfs::FileSystem::new(img_file, fatfs::FsOptions::new())?;

    let root_dir = fs.root_dir();

    let mut file = root_dir.create_file("hello.txt")?;

    file.write_all(b"Hello World!")?;

Note: it is recommended to wrap the underlying file struct in a buffering/caching object like `BufStream` from

`fscommon` crate. For example:

    let buf_stream = BufStream::new(img_file);

    let fs = fatfs::FileSystem::new(buf_stream, fatfs::FsOptions::new())?;

See more examples in the `examples` subdirectory.

no_std usage

------------

Add this to your `Cargo.toml`:

    [dependencies]

    fatfs = { version = "0.4", default-features = false }

Additional features:

* `lfn` - LFN (long file name) support

* `alloc` - use `alloc` crate for dynamic allocation. Needed for API which uses `String` type. You may have to provide

a memory allocator implementation.

* `unicode` - use Unicode-compatible case conversion in file names - you may want to have it disabled for lower memory

footprint

* `log_level_*` - enable specific logging levels at compile time.

The options are as follows:

  * `log_level_error` - enable only error-level logging.

  * `log_level_warn` - enable warn-level logging and higher.

  * `log_level_info` - enable info-level logging and higher.

  * `log_level_debug` - enable debug-level logging and higher.

  * `log_level_trace` - (default) enable all logging levels, trace and higher.

Note: above features are enabled by default and were designed primarily for `no_std` usage.

License

-------

The MIT license. See `LICENSE.txt`.