aboutsummaryrefslogtreecommitdiff

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] 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.

GitHub Build Status

Usage

Add the following lines to your "Cargo.toml" file:

[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:

Target Target Triple Minimum Version
Fortanix *-fortanix-*-sgx nightly (sgx_platform)
HermitCore *-*-hermit 1.57.0
SOLID *-*-solid_asp3(-*) 1.57.0
Unix Unix 1.57.0
WASI *-wasi 1.57.0
WebAssembly wasm32-*-unknown 1.57.0
Windows *-*-windows-* 1.57.0
Xous *-*-xous-* unstable

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:

[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.