pistonite-cu 0.9.1

Battery-included common utils to speed up development of rust tools
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use std::ffi::{OsStr, OsString};
use std::path::{Path, PathBuf};

use cu::Context as _;

/// Convenience trait for working with [`OsStr`](std::ffi::OsStr)
///
/// See [File System Paths and Strings](trait@crate::str::PathExtension)
pub trait OsStrExtension {
    /// Get the path as UTF-8, error if it's not UTF-8
    fn as_utf8(&self) -> cu::Result<&str>;
}
/// Convenience trait for working with [`OsString`](std::ffi::OsString)
///
/// See [File System Paths and Strings](trait@crate::str::PathExtension)
pub trait OsStrExtensionOwned {
    /// Get the path as UTF-8, error if it's not UTF-8
    fn into_utf8(self) -> cu::Result<String>;
}

impl OsStrExtension for OsStr {
    #[inline(always)]
    fn as_utf8(&self) -> cu::Result<&str> {
        // to_str is ok on all platforms, because Rust internally
        // represent OsStrings on Windows as WTF-8
        // see https://doc.rust-lang.org/src/std/sys_common/wtf8.rs.html
        cu::check!(self.to_str(), "not utf-8: {self:?}")
    }
}

impl OsStrExtension for Path {
    #[inline(always)]
    fn as_utf8(&self) -> cu::Result<&str> {
        self.as_os_str().as_utf8()
    }
}

impl OsStrExtensionOwned for OsString {
    #[inline(always)]
    fn into_utf8(self) -> cu::Result<String> {
        match self.into_string() {
            Ok(s) => Ok(s),
            Err(e) => cu::bail!("not utf-8: {e:?}"),
        }
    }
}
impl OsStrExtensionOwned for PathBuf {
    #[inline(always)]
    fn into_utf8(self) -> cu::Result<String> {
        self.into_os_string().into_utf8()
    }
}

#[cfg(all(test, unix))]
mod test {
    use super::*;
    use std::os::unix::ffi::OsStrExt as _;
    #[test]
    fn test_not_utf8() {
        let s = OsStr::from_bytes(b"hello\xffworld");
        let result = s.as_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\xFFworld""#);
        let result = Path::new(s).as_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\xFFworld""#);

        let s = s.to_owned();
        let result = s.clone().into_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\xFFworld""#);
        let result = PathBuf::from(s).into_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\xFFworld""#);
    }
    #[test]
    fn test_utf8() {
        let s = OsStr::from_bytes(b"hello world");
        assert!(s.as_utf8().is_ok());
        assert!(Path::new(s).as_utf8().is_ok());

        let s = s.to_owned();
        assert!(s.clone().into_utf8().is_ok());
        assert!(PathBuf::from(s).into_utf8().is_ok());
    }
}

#[cfg(all(test, windows))]
mod test {
    use super::*;
    use std::os::windows::ffi::OsStringExt as _;
    #[test]
    fn test_not_utf8() {
        let wide: &[u16] = &[
            0x0068, 0x0065, 0x006C, 0x006C, 0x006F, 0xD800, 0x0077, 0x006F, 0x0072, 0x006C, 0x0064,
        ];
        let s = OsString::from_wide(wide);
        let result = s.as_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\u{d800}world""#);
        let result = Path::new(&s).as_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\u{d800}world""#);

        let result = s.clone().into_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\u{d800}world""#);
        let result = PathBuf::from(s).into_utf8().unwrap_err().to_string();
        assert_eq!(result, r#"not utf-8: "hello\u{d800}world""#);
    }
    #[test]
    fn test_utf8() {
        let wide: &[u16] = &[
            0x0068, 0x0065, 0x006C, 0x006C, 0x006F, 0x0020, 0x0077, 0x006F, 0x0072, 0x006C, 0x0064,
        ];
        let s = OsString::from_wide(wide);
        assert!(s.as_utf8().is_ok());
        assert!(Path::new(&s).as_utf8().is_ok());
        assert!(s.clone().into_utf8().is_ok());
        assert!(PathBuf::from(s).into_utf8().is_ok());
    }
}