rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add caveat to Path::display() about lossiness

Browse Source
This commit is contained in:
Manish Goregaokar
2021-02-16 11:45:46 -08:00
parent 9d3deed8a2
commit a98b22c837
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
library/std/src/path.rs
View File

@@ -2321,7 +2321,9 @@ impl Path {
} }
/// Returns an object that implements [`Display`] for safely printing paths /// Returns an object that implements [`Display`] for safely printing paths
/// that may contain non-Unicode data. /// that may contain non-Unicode data. This may perform lossy conversion,
/// depending on the platform. If you would like an implementation which
/// escapes the path please use [`Debug`] instead.
/// ///
/// [`Display`]: fmt::Display /// [`Display`]: fmt::Display
/// ///
@@ -2555,7 +2557,9 @@ impl fmt::Debug for Path {
/// ///
/// A [`Path`] might contain non-Unicode data. This `struct` implements the /// A [`Path`] might contain non-Unicode data. This `struct` implements the
/// [`Display`] trait in a way that mitigates that. It is created by the /// [`Display`] trait in a way that mitigates that. It is created by the
/// [`display`](Path::display) method on [`Path`]. /// [`display`](Path::display) method on [`Path`]. This may perform lossy
/// conversion, depending on the platform. If you would like an implementation
/// which escapes the path please use [`Debug`] instead.
/// ///
/// # Examples /// # Examples
/// ///