nicholasbishop / ext4-view-rs

Rust library for reading ext2/ext4 filesystems
https://crates.io/crates/ext4-view
Apache License 2.0
8 stars 2 forks source link

Improve error documentation #119

Closed nicholasbishop closed 2 months ago

nicholasbishop commented 3 months ago

I've been vaguely thinking that for common errors I'd put some docs in the top-level doc for Ext4. Otherwise each of these methods would have to list malformed path, symlink loop, corrupt filesystem, path too long, etc, which would get a bit unwieldy. I should probably add a "this list is not exhaustive" note to each of these methods though, like std::fs does: https://doc.rust-lang.org/std/fs/fn.read_dir.html#errors

_Originally posted by @nicholasbishop in https://github.com/nicholasbishop/ext4-view-rs/pull/116#discussion_r1661255034_