Idiomatic Rust API for littlefs
littlefs2
What is this?
Idiomatic Rust API for the [littlefs][littlefs] microcontroller filesystem by [Chris Haster][geky].
Number 2 refers to the on-disk format version, [supporting inline files, custom attributes and dynamic wear-leveling][release-notes-2].
We follow [std::fs][std-fs] as much as reasonable.
The low-level bindings are provided by the [littlefs2-sys][littlefs2-sys] library.
The core types that are independent of a specific implementation version are provided by the littlefs2-core crate, see the core directory. These types are re-exported from the littlefs2 crate too.
Upstream release: [v2.9.3][upstream-release]
[geky]: https://github.com/geky [littlefs]: https://github.com/littlefs-project/littlefs [release-notes-2]: https://github.com/littlefs-project/littlefs/releases/tag/v2.0.0 [std-fs]: https://doc.rust-lang.org/std/fs/index.html [littlefs2-sys]: https://lib.rs/littlefs2-sys [upstream-release]: https://github.com/littlefs-project/littlefs/releases/tag/v2.9.3
no_std
This library is no_std compatible, but there are two gotchas.
- The dev-dependency
memchroflittlefs2-syshas itsstdfeatures activated. To prevent this, upgrade to at least Rust 1.51
resolver = "2" in the consuming code's [package] section. This will be the default in Rust 2021 edition.
- At link time,
lfs.chas a dependency onstrcpy. When not linking to alibcwith this symbol, activate thec-stubsfeature
License
littlefs is licensed under BSD-3-Clause. This API for littlefs is licensed under either of Apache License, Version 2.0 or MIT License at your option. Previous bindings exist in the rust-littlefs repository, also dual-licensed under Apache-2.0 and MIT.
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.