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
|
# OsStr Bytes
This crate allows interacting with the data stored by [`OsStr`] and
[`OsString`], without resorting to panics or corruption for invalid UTF-8.
Thus, methods can be used that are already defined on [`[u8]`][slice] and
[`Vec<u8>`].
Typically, the only way to losslessly construct [`OsStr`] or [`OsString`] from
a byte sequence is to use `OsStr::new(str::from_utf8(bytes)?)`, which requires
the bytes to be valid in UTF-8. However, since this crate makes conversions
directly between the platform encoding and raw bytes, even some strings invalid
in UTF-8 can be converted.
[](https://github.com/dylni/os_str_bytes/actions?query=branch%3Amaster)
## Usage
Add the following lines to your "Cargo.toml" file:
```toml
[dependencies]
os_str_bytes = "6.4"
```
See the [documentation] for available functionality and examples.
## Rust version support
The minimum supported Rust toolchain version depends on the platform:
<table>
<tr>
<th>Target</th>
<th>Target Triple</th>
<th>Minimum Version</th>
</tr>
<tr>
<td>Fortanix</td>
<td><code>*-fortanix-*-sgx</code></td>
<td>nightly (<a href="https://doc.rust-lang.org/unstable-book/library-features/sgx-platform.html"><code>sgx_platform</code></a>)</td>
</tr>
<tr>
<td>HermitCore</td>
<td><code>*-*-hermit</code></td>
<td>1.57.0</td>
</tr>
<tr>
<td>SOLID</td>
<td><code>*-*-solid_asp3(-*)</code></td>
<td>1.57.0</td>
</tr>
<tr>
<td>Unix</td>
<td>Unix</td>
<td>1.57.0</td>
</tr>
<tr>
<td>WASI</td>
<td><code>*-wasi</code></td>
<td>1.57.0</td>
</tr>
<tr>
<td>WebAssembly</td>
<td><code>wasm32-*-unknown</code></td>
<td>1.57.0</td>
</tr>
<tr>
<td>Windows</td>
<td><code>*-*-windows-*</code></td>
<td>1.57.0</td>
</tr>
<tr>
<td>Xous</td>
<td><code>*-*-xous-*</code></td>
<td>unstable</td>
</tr>
</table>
Minor version updates may increase these version requirements. However, the
previous two Rust releases will always be supported. If the minimum Rust
version must not be increased, use a tilde requirement to prevent updating this
crate's minor version:
```toml
[dependencies]
os_str_bytes = "~6.4"
```
## License
Licensing terms are specified in [COPYRIGHT].
Unless you explicitly state otherwise, any contribution submitted for inclusion
in this crate, as defined in [LICENSE-APACHE], shall be licensed according to
[COPYRIGHT], without any additional terms or conditions.
[COPYRIGHT]: https://github.com/dylni/os_str_bytes/blob/master/COPYRIGHT
[documentation]: https://docs.rs/os_str_bytes
[LICENSE-APACHE]: https://github.com/dylni/os_str_bytes/blob/master/LICENSE-APACHE
[slice]: https://doc.rust-lang.org/std/primitive.slice.html
[`OsStr`]: https://doc.rust-lang.org/std/ffi/struct.OsStr.html
[`OsString`]: https://doc.rust-lang.org/std/ffi/struct.OsString.html
[`Vec<u8>`]: https://doc.rust-lang.org/std/vec/struct.Vec.html
|
