Skip to content

Commit

Permalink
Rollup merge of #98202 - aticu:impl_tryfrom_osstr_for_str, r=Amanieu
Browse files Browse the repository at this point in the history
Implement `TryFrom<&OsStr>` for `&str`

Recently when trying to work with `&OsStr` I was surprised to find this `impl` missing.

Since the `to_str` method already existed the actual implementation is fairly non-controversial, except for maybe the choice of the error type. I chose an opaque error here instead of something like `std::str::Utf8Error`, since that would already make a number of assumption about the underlying implementation of `OsStr`.

As this is a trait implementation, it is insta-stable, if I'm not mistaken?
Either way this will need an FCP.
I chose "1.64.0" as the version, since this is unlikely to land before the beta cut-off.

`@rustbot` modify labels: +T-libs-api

API Change Proposal: #99031 (accepted)
  • Loading branch information
matthiaskrgr committed Jun 14, 2023
2 parents 7b0eac4 + e3a1a11 commit 4efdb5c
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 14 deletions.
20 changes: 19 additions & 1 deletion library/std/src/ffi/os_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ impl OsStr {
without modifying the original"]
#[inline]
pub fn to_str(&self) -> Option<&str> {
self.inner.to_str()
self.inner.to_str().ok()
}

/// Converts an `OsStr` to a <code>[Cow]<[str]></code>.
Expand Down Expand Up @@ -1165,6 +1165,24 @@ impl<'a> From<Cow<'a, OsStr>> for OsString {
}
}

#[stable(feature = "str_tryfrom_osstr_impl", since = "CURRENT_RUSTC_VERSION")]
impl<'a> TryFrom<&'a OsStr> for &'a str {
type Error = crate::str::Utf8Error;

/// Tries to convert an `&OsStr` to a `&str`.
///
/// ```
/// use std::ffi::OsStr;
///
/// let os_str = OsStr::new("foo");
/// let as_str = <&str>::try_from(os_str).unwrap();
/// assert_eq!(as_str, "foo");
/// ```
fn try_from(value: &'a OsStr) -> Result<Self, Self::Error> {
value.inner.to_str()
}
}

#[stable(feature = "box_default_extra", since = "1.17.0")]
impl Default for Box<OsStr> {
#[inline]
Expand Down
4 changes: 2 additions & 2 deletions library/std/src/sys/unix/os_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ impl Slice {
unsafe { Slice::from_os_str_bytes_unchecked(s.as_bytes()) }
}

pub fn to_str(&self) -> Option<&str> {
str::from_utf8(&self.inner).ok()
pub fn to_str(&self) -> Result<&str, crate::str::Utf8Error> {
str::from_utf8(&self.inner)
}

pub fn to_string_lossy(&self) -> Cow<'_, str> {
Expand Down
2 changes: 1 addition & 1 deletion library/std/src/sys/windows/os_str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ impl Slice {
unsafe { mem::transmute(Wtf8::from_str(s)) }
}

pub fn to_str(&self) -> Option<&str> {
pub fn to_str(&self) -> Result<&str, crate::str::Utf8Error> {
self.inner.as_str()
}

Expand Down
9 changes: 2 additions & 7 deletions library/std/src/sys_common/wtf8.rs
Original file line number Diff line number Diff line change
Expand Up @@ -626,13 +626,8 @@ impl Wtf8 {
///
/// This does not copy the data.
#[inline]
pub fn as_str(&self) -> Option<&str> {
// Well-formed WTF-8 is also well-formed UTF-8
// if and only if it contains no surrogate.
match self.next_surrogate(0) {
None => Some(unsafe { str::from_utf8_unchecked(&self.bytes) }),
Some(_) => None,
}
pub fn as_str(&self) -> Result<&str, str::Utf8Error> {
str::from_utf8(&self.bytes)
}

/// Creates an owned `Wtf8Buf` from a borrowed `Wtf8`.
Expand Down
6 changes: 3 additions & 3 deletions library/std/src/sys_common/wtf8/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -521,11 +521,11 @@ fn wtf8_code_points() {

#[test]
fn wtf8_as_str() {
assert_eq!(Wtf8::from_str("").as_str(), Some(""));
assert_eq!(Wtf8::from_str("aé 💩").as_str(), Some("aé 💩"));
assert_eq!(Wtf8::from_str("").as_str(), Ok(""));
assert_eq!(Wtf8::from_str("aé 💩").as_str(), Ok("aé 💩"));
let mut string = Wtf8Buf::new();
string.push(CodePoint::from_u32(0xD800).unwrap());
assert_eq!(string.as_str(), None);
assert!(string.as_str().is_err());
}

#[test]
Expand Down

0 comments on commit 4efdb5c

Please sign in to comment.