Skip to content

Commit 135f227

Browse files
committed
Remove the description of arf-strings from fs_utf8 module comments.
arf-strings are an experiment, and not necessarily something all users need to know about just to use fs_utf8, especially now that we have camino. So remove the top-level comments talking about arf strings from the module documentation. arf-strings are still mentioned in the top-level repository README.md, which is sufficient visibility for them for now.
1 parent 8522e74 commit 135f227

File tree

2 files changed

+0
-24
lines changed

2 files changed

+0
-24
lines changed

cap-async-std/src/fs_utf8/mod.rs

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,10 @@
44
//! module uses [`Utf8Path`] and [`Utf8PathBuf`], meaning that all paths are
55
//! valid UTF-8.
66
//!
7-
//! But wait, POSIX doesn't require filenames to be UTF-8! What happens if
8-
//! there's a file with a non-UTF-8 name? To address this, this module uses
9-
//! [ARF strings] to encode non-UTF-8-encodable filenames as UTF-8. See the
10-
//! link for details, but the big picture is that all possible byte sequences
11-
//! are losslessly representable. The easy case of a file with a valid UTF-8
12-
//! name is easy, and the tricky case of a valid with an invalid UTF-8 name
13-
//! is possible -- it may take more work to handle properly, especially if
14-
//! you want to do interesting path manipulation, but it is possible.
15-
//!
16-
//! TODO: This whole scheme is still under development.
17-
//!
187
//! If you don't want this, use the regular [`cap_async_std::fs`] module
198
//! instead.
209
//!
2110
//! [`cap_async_std::fs`]: ../fs/
22-
//! [ARF strings]: https://crates.io/crates/arf-strings
2311
2412
mod dir;
2513
mod dir_entry;

cap-std/src/fs_utf8/mod.rs

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,12 @@
44
//! uses [`Utf8Path`] and [`Utf8PathBuf`], meaning that all paths are valid
55
//! UTF-8.
66
//!
7-
//! But wait, POSIX doesn't require filenames to be UTF-8! What happens if
8-
//! there's a file with a non-UTF-8 name? To address this, this module uses
9-
//! [ARF strings] to encode non-UTF-8-encodable filenames as UTF-8. See the
10-
//! link for details, but the big picture is that all possible byte sequences
11-
//! are losslessly representable. The easy case of a file with a valid UTF-8
12-
//! name is easy, and the tricky case of a valid with an invalid UTF-8 name
13-
//! is possible -- it may take more work to handle properly, especially if
14-
//! you want to do interesting path manipulation, but it is possible.
15-
//!
16-
//! TODO: This whole scheme is still under development.
17-
//!
187
//! To use this module, enable the `fs_utf8` cargo feature.
198
//!
209
//! If you don't want to restrict paths to UTF-8, use the regular
2110
//! [`cap_std::fs`] module instead.
2211
//!
2312
//! [`cap_std::fs`]: ../fs/
24-
//! [ARF strings]: https://crates.io/crates/arf-strings
2513
2614
mod dir;
2715
mod dir_entry;

0 commit comments

Comments
 (0)