.github/workflows/build.yml

@@ -3,18 +3,23 @@ name: build
 on:
   pull_request:
   push:
+    branches:
+    - master
   schedule:
   - cron: 0 0 * * FRI
 
 jobs:
   build:
     runs-on: ${{ matrix.platform }}
+    env:
+      RUSTFLAGS: -Dwarnings
     steps:
     - uses: actions/checkout@v1
       with:
         fetch-depth: 10
-    - run: cargo clippy -- -Dwarnings
-    - run: cargo clippy --all-features --tests -- -Dwarnings
+    - run: cargo install cargo-hack
+    - run: cargo hack clippy --feature-powerset --optional-deps
+    - run: cargo hack clippy --feature-powerset --optional-deps --tests
     - run: cargo fmt -- --check
     timeout-minutes: 5
     strategy:
@@ -23,44 +28,36 @@ jobs:
   build-other:
     needs: [build]
     runs-on: ubuntu-latest
+    env:
+      RUSTFLAGS: -Dwarnings
+      flags: --feature-powerset --optional-deps --target ${{ matrix.target }}
     steps:
     - uses: actions/checkout@v1
       with:
         fetch-depth: 10
     - run: rustup install ${{ matrix.version }}
     - run: rustup default ${{ matrix.version }}
-    - run: rustup component add clippy
+    # Clippy might not be packaged with the current nightly compiler or might
+    # include broken lints on the nightly channel.
+    #
+    # Running Clippy on older versions prevents taking advantage of
+    # improvements to its lints.
+    - if: matrix.version == 'stable'
+      run: rustup component add clippy
     - run: rustup target add ${{ matrix.target }}
-    - run: cargo clippy --all-features --target ${{ matrix.target }} -- -Dwarnings
+    - run: cargo install cargo-hack
+    - if: matrix.version == 'stable'
+      run: cargo hack clippy ${{ env.flags }}
+    - if: matrix.version != 'stable'
+      run: cargo hack rustc ${{ env.flags }}
     timeout-minutes: 5
     strategy:
       matrix:
         target: [wasm32-unknown-unknown, wasm32-wasi, x86_64-unknown-redox]
-        # Clippy might not be packaged with the current nightly compiler.
-        version: [stable, beta]
+        version: [1.52.0, stable, beta, nightly]
         include:
-        - target: wasm32-unknown-unknown
-          version: 1.34.0
-        - target: wasm32-unknown-wasi
-          version: 1.35.0
-        - target: x86_64-unknown-redox
-          version: 1.34.0
-  build-other-unstable:
-    needs: [build]
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-      with:
-        fetch-depth: 10
-    - run: rustup install nightly
-    - run: rustup default nightly
-    - run: rustup target add ${{ matrix.target }}
-    # Clippy might not be packaged with the current nightly compiler.
-    - run: cargo rustc --all-features --target ${{ matrix.target }} -- -Dwarnings
-    timeout-minutes: 5
-    strategy:
-      matrix:
-        target: [x86_64-fortanix-unknown-sgx]
+        - target: x86_64-fortanix-unknown-sgx
+          version: nightly
   test:
     needs: [build]
     runs-on: ${{ matrix.platform }}
@@ -72,11 +69,12 @@ jobs:
         fetch-depth: 10
     - run: rustup install ${{ matrix.version }}
     - run: rustup default ${{ matrix.version }}
-    - run: cargo test
+    - run: cargo test --no-default-features
+    - run: cargo test --no-default-features --features raw_os_str
     - run: cargo test --all-features
-    - run: cargo test --release
+    - run: cargo test --all-features --release
     timeout-minutes: 10
     strategy:
       matrix:
         platform: [macos-latest, ubuntu-latest, windows-latest]
-        version: [1.34.0, stable, nightly]
+        version: [1.52.0, stable, beta, nightly]

Cargo.toml

@@ -1,25 +1,33 @@
 [package]
 name = "os_str_bytes"
-version = "3.1.0"
+version = "6.0.0"
 authors = ["dylni"]
 edition = "2018"
-exclude = [".*", "/rustfmt.toml", "/tests"]
+rust-version = "1.52.0"
 description = """
-Traits for converting between byte sequences and platform-native strings
+Utilities for converting between byte sequences and platform-native strings
 """
-repository = "https://github.com/dylni/os_str_bytes"
 readme = "README.md"
+repository = "https://github.com/dylni/os_str_bytes"
+license = "MIT OR Apache-2.0"
 keywords = ["bytes", "osstr", "osstring", "path", "windows"]
 categories = ["command-line-interface", "development-tools::ffi", "encoding", "os", "rust-patterns"]
-license = "MIT OR Apache-2.0"
+exclude = [".*", "/rustfmt.toml", "/tests"]
 
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "os_str_bytes_docs_rs"]
 rustdoc-args = ["--cfg", "os_str_bytes_docs_rs"]
 
+[dependencies]
+memchr = { version = "2.4", optional = true }
+print_bytes = { version = "0.5", optional = true }
+uniquote = { version = "3.0", optional = true }
+
 [dev-dependencies]
-getrandom = { version = "0.2", features = ["js"] }
+getrandom = "0.2"
 
 [features]
-raw = []
+default = ["memchr", "raw_os_str"]
+
+raw_os_str = []

README.md

@@ -1,6 +1,6 @@
 # OsStr Bytes
 
-This crate allows interacting with the data stored internally by [`OsStr`] and
+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>`].
@@ -19,7 +19,7 @@ Add the following lines to your "Cargo.toml" file:
 
 ```toml
 [dependencies]
-os_str_bytes = "3.1"
+os_str_bytes = "6.0"
 ```
 
 See the [documentation] for available functionality and examples.
@@ -39,36 +39,38 @@ The minimum supported Rust toolchain version depends on the platform:
         <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 rowspan="2">JavaScript</td>
-        <td><code>wasm32-*-emscripten</code></td>
-        <td rowspan="2">1.34.0</td>
-    </tr>
-    <tr>
-        <td><code>wasm32-*-unknown</code></td>
-    </tr>
-    <tr>
-        <td>Redox</td>
-        <td><code>*-redox</code></td>
-        <td>1.34.0</td>
-    </tr>
     <tr>
         <td>Unix</td>
         <td>Unix</td>
-        <td>1.34.0</td>
+        <td>1.52.0</td>
     </tr>
     <tr>
         <td>WASI</td>
         <td><code>*-wasi</code></td>
-        <td>1.35.0 (all versions)</td>
+        <td>1.52.0</td>
+    </tr>
+    <tr>
+        <td>WebAssembly</td>
+        <td><code>wasm32-*-unknown</code></td>
+        <td>1.52.0</td>
     </tr>
     <tr>
         <td>Windows</td>
         <td><code>*-windows-*</code></td>
-        <td>1.34.0</td>
+        <td>1.52.0</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.0"
+```
+
 ## License
 
 Licensing terms are specified in [COPYRIGHT].

src/common/mod.rs

@@ -6,40 +6,34 @@ use std::result;
 
 #[cfg(all(target_vendor = "fortanix", target_env = "sgx"))]
 use std::os::fortanix_sgx as os;
-#[cfg(any(target_os = "hermit", target_os = "redox", unix))]
+#[cfg(any(target_os = "hermit", unix))]
 use std::os::unix as os;
-#[cfg(any(target_env = "wasi", target_os = "wasi"))]
+#[cfg(target_os = "wasi")]
 use std::os::wasi as os;
 
 use os::ffi::OsStrExt;
 use os::ffi::OsStringExt;
 
-if_raw! {
+if_raw_str! {
     pub(super) mod raw;
 }
 
 pub(super) type EncodingError = Infallible;
 
 type Result<T> = result::Result<T, EncodingError>;
 
-#[allow(renamed_and_removed_lints)]
-#[allow(clippy::unknown_clippy_lints)]
-#[allow(clippy::unnecessary_wraps)]
-pub(crate) fn os_str_from_bytes(string: &[u8]) -> Result<Cow<'_, OsStr>> {
+pub(super) fn os_str_from_bytes(string: &[u8]) -> Result<Cow<'_, OsStr>> {
     Ok(Cow::Borrowed(OsStrExt::from_bytes(string)))
 }
 
-pub(crate) fn os_str_to_bytes(os_string: &OsStr) -> Cow<'_, [u8]> {
+pub(super) fn os_str_to_bytes(os_string: &OsStr) -> Cow<'_, [u8]> {
     Cow::Borrowed(OsStrExt::as_bytes(os_string))
 }
 
-#[allow(renamed_and_removed_lints)]
-#[allow(clippy::unknown_clippy_lints)]
-#[allow(clippy::unnecessary_wraps)]
-pub(crate) fn os_string_from_vec(string: Vec<u8>) -> Result<OsString> {
+pub(super) fn os_string_from_vec(string: Vec<u8>) -> Result<OsString> {
     Ok(OsStringExt::from_vec(string))
 }
 
-pub(crate) fn os_string_into_vec(os_string: OsString) -> Vec<u8> {
+pub(super) fn os_string_into_vec(os_string: OsString) -> Vec<u8> {
     OsStringExt::into_vec(os_string)
 }

src/common/raw.rs

@@ -1,7 +1,38 @@
+use std::fmt;
+use std::fmt::Formatter;
+
+#[inline(always)]
+pub(crate) const fn is_continuation(_: u8) -> bool {
+    false
+}
+
+#[inline(always)]
+pub(crate) fn decode_code_point(_: &[u8]) -> u32 {
+    unreachable!();
+}
+
 pub(crate) fn ends_with(string: &[u8], suffix: &[u8]) -> bool {
     string.ends_with(suffix)
 }
 
 pub(crate) fn starts_with(string: &[u8], prefix: &[u8]) -> bool {
     string.starts_with(prefix)
 }
+
+pub(crate) fn debug(string: &[u8], f: &mut Formatter<'_>) -> fmt::Result {
+    for byte in string {
+        write!(f, "\\x{:02X}", byte)?;
+    }
+    Ok(())
+}
+
+#[cfg(feature = "uniquote")]
+pub(crate) mod uniquote {
+    use uniquote::Formatter;
+    use uniquote::Quote;
+    use uniquote::Result;
+
+    pub(crate) fn escape(string: &[u8], f: &mut Formatter<'_>) -> Result {
+        string.escape(f)
+    }
+}