rust-fatfs/README.md
Rafał Harabień d5c37f2af5 Introduce FsOptions struct for providing options for library.
Old read_only flag in FileSystem::new was misleading.
2017-11-08 20:26:50 +01:00

1.3 KiB

Rust FAT FS

Travis Build Status MIT licensed crates.io Documentation

FAT filesystem library implemented in Rust.

Features:

  • read/write/create/remove file,
  • enumerate directory children,
  • create/remove directory,
  • read/write file timestamps (updated automatically if chrono is available),
  • FAT12, FAT16, FAT32 compatibility,
  • LFN (Long File Names) extension supported.

Usage

Put this in your Cargo.toml:

[dependencies]
fatfs = "0.1"

Put this in your crate root:

extern crate fatfs;

You can start using library now:

let img_file = File::open("fat.img").unwrap();
let mut buf_stream = fatfs::BufStream::new(img_file);
let fs = fatfs::FileSystem::new(&mut buf_stream, fatfs::FsOptions::new()).unwrap();
let mut root_dir = fs.root_dir();
let mut file = root_dir.create_file("hello.txt").unwrap();
file.write_all(b"Hello World!").unwrap();

See more examples in examples subdirectory.

License

The MIT license. See LICENSE.txt.