Merge 7117109 into 6a37c9d

.github/workflows/coverage.yml

@@ -0,0 +1,22 @@
+name: Coverage
+
+on: [pull_request, push]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    env:
+      CARGO_TERM_COLOR: always
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Rust
+        run: rustup update stable
+      - name: Install cargo-llvm-cov
+        uses: taiki-e/install-action@cargo-llvm-cov
+      - name: Generate code coverage
+        run: cargo llvm-cov --workspace --codecov --output-path codecov.json
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          files: codecov.json
+          fail_ci_if_error: true

.github/workflows/main.yml

@@ -33,30 +33,31 @@ jobs:
           command: test
           args: --all
 
-  test_miri:
-    name: Miri Test
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: nightly
-          override: true
-          components: miri
-      - run: cargo miri test
-
-  test_miri_big_endian:
-    name: Miri Test Big Endian
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: nightly
-          override: true
-          components: miri
-          target: mips64-unknown-linux-gnuabi64
-      - run: cargo miri test --target mips64-unknown-linux-gnuabi64
+# TODO: Enable Miri
+#  test_miri:
+#    name: Miri Test
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - uses: actions-rs/toolchain@v1
+#        with:
+#          toolchain: nightly
+#          override: true
+#          components: miri
+#      - run: cargo miri test
+#
+#  test_miri_big_endian:
+#    name: Miri Test Big Endian
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@v3
+#      - uses: actions-rs/toolchain@v1
+#        with:
+#          toolchain: nightly
+#          override: true
+#          components: miri
+#          target: armebv7r-none-eabi
+#      - run: cargo miri test --target armebv7r-none-eabi
 
   examples:
     name: Examples
@@ -111,7 +112,8 @@ jobs:
         with:
           toolchain: nightly
           override: true
-      - run: cd ensure_no_std && cargo run --release
+          target: thumbv7em-none-eabihf
+      - run: cd ensure_no_std && cargo build --release --target thumbv7em-none-eabihf
 
   ensure_wasm:
     name: Ensure wasm
@@ -126,20 +128,3 @@ jobs:
         with:
           version: 'latest'
       - run: cd ensure_wasm && wasm-pack build --target web && wasm-pack test --node
-
-  coverage:
-    name: Coverage
-    runs-on: ubuntu-latest
-    container:
-      image: xd009642/tarpaulin:develop
-      options: --security-opt seccomp=unconfined
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Generate code coverage
-        run: |
-          cargo tarpaulin --verbose --all-features --workspace --timeout 120 --out Xml
-
-      - name: Upload to codecov.io
-        uses: codecov/codecov-action@v1

CHANGELOG.md

@@ -2,6 +2,142 @@
 
 ## [Unreleased]
 
+## Changes
+[#352](/~https://github.com/sharksforarms/deku/pull/352) replaced the byte slice interface with new interfaces depending on `io::Read`.
+This brings massive performance and usability improvements.
+- `from_bytes(..)` was replaced with `from_reader(..)`:
+
+old:
+```rust
+#[derive(Debug, PartialEq, DekuRead, DekuWrite)]
+struct TestDeku(#[deku(bits = 4)] u8);
+
+let test_data: Vec<u8> = [0b0110_0110u8, 0b0101_1010u8].to_vec();
+
+let ((rest, i), ret_read) = TestDeku::from_bytes((&test_data, 0)).unwrap();
+assert_eq!(TestDeku(0b0110), ret_read);
+assert_eq!(2, rest.len());
+assert_eq!(4, i);
+```
+
+new:
+```rust
+#[derive(Debug, PartialEq, DekuRead, DekuWrite)]
+struct TestDeku(#[deku(bits = 4)] u8);
+
+let test_data: Vec<u8> = [0b0110_0110u8, 0b0101_1010u8].to_vec();
+let mut c = std::io::Cursor::new(test_data);
+
+let (amt_read, ret_read) = TestDeku::from_reader((&mut c, 0)).unwrap();
+assert_eq!(TestDeku(0b0110), ret_read);
+assert_eq!(amt_read, 4);
+```
+
+- The more internal (with context) `read(..)` was replaced with `from_reader_with_ctx(..)`.
+Now unused variables `deku::input`, `deku::input_bits`, and `deku::rest` were removed. `deku::reader` is the replacement.
+
+old:
+```rust
+#[derive(Debug, PartialEq, DekuRead, DekuWrite)]
+struct DekuTest {
+    field_a: u8,
+
+    #[deku(
+        reader = "bit_flipper_read(*field_a, deku::rest, BitSize(8))",
+    )]
+    field_b: u8,
+}
+
+fn custom_read(
+    field_a: u8,
+    rest: &BitSlice<u8, Msb0>,
+    bit_size: BitSize,
+) -> Result<(&BitSlice<u8, Msb0>, u8), DekuError> {
+
+    // read field_b, calling original func
+    let (rest, value) = u8::read(rest, bit_size)?;
+
+    Ok((rest, value))
+}
+```
+
+new:
+```rust
+#[derive(Debug, PartialEq, DekuRead, DekuWrite)]
+struct DekuTest {
+    field_a: u8,
+
+    #[deku(
+        reader = "bit_flipper_read(*field_a, deku::reader, BitSize(8))",
+    )]
+    field_b: u8,
+}
+
+fn custom_read<R: std::io::Read>(
+    field_a: u8,
+    reader: &mut Reader<R>,
+    bit_size: BitSize,
+) -> Result<u8, DekuError> {
+
+    // read field_b, calling original func
+    let value = u8::from_reader_with_ctx(reader, bit_size)?;
+
+    Ok(value)
+}
+```
+
+- With the addition of using `Read`, containing a byte slice with a reference is not supported:
+
+old
+```rust
+#[derive(PartialEq, Debug, DekuRead, DekuWrite)]
+struct TestStruct<'a> {
+    bytes: u8,
+
+    #[deku(bytes_read = "bytes")]
+    data: &'a [u8],
+}
+```
+
+new
+```rust
+#[derive(PartialEq, Debug, DekuRead, DekuWrite)]
+struct TestStruct {
+    bytes: u8,
+
+    #[deku(bytes_read = "bytes")]
+    data: Vec<u8>,
+}
+```
+
+- `id_pat` is now required to be the same type as stored id.
+This also disallows using tuples for storing the id:
+
+old:
+```rust
+#[derive(PartialEq, Debug, DekuRead, DekuWrite)]
+#[deku(type = "u8")]
+enum DekuTest {
+    #[deku(id_pat = "_")]
+    VariantC((u8, u8)),
+}
+```
+
+new:
+```rust
+#[derive(PartialEq, Debug, DekuRead, DekuWrite)]
+#[deku(type = "u8")]
+enum DekuTest {
+    #[deku(id_pat = "_")]
+    VariantC {
+        id: u8,
+        other: u8,
+    },
+}
+```
+
+- The feature `const_generics` was removed and is enabled by default.
+
 ## [0.16.0] - 2023-02-28
 
 ### Changes

Cargo.toml

@@ -9,6 +9,7 @@ keywords = ["deku", "bits", "serialization", "deserialization", "struct"]
 categories = ["encoding", "parsing", "no-std"]
 description = "bit level serialization/deserialization proc-macro for structs"
 readme = "README.md"
+rust-version = "1.65.0"
 
 [lib]
 bench = false
@@ -19,16 +20,16 @@ members = [
 ]
 
 [features]
-default = ["std", "const_generics"]
-std = ["deku_derive/std", "bitvec/std", "alloc"]
+default = ["std"]
+std = ["deku_derive/std", "bitvec/std", "alloc", "no_std_io/std"]
 alloc = ["bitvec/alloc"]
 logging = ["deku_derive/logging", "log"]
-const_generics = []
 
 [dependencies]
 deku_derive = { version = "^0.16.0", path = "deku-derive", default-features = false}
 bitvec = { version = "1.0.1", default-features = false }
 log = { version = "0.4.17", optional = true }
+no_std_io = { version = "0.5.0", default-features = false, features = ["alloc"] }
 
 [dev-dependencies]
 rstest = "0.16.0"

README.md

@@ -30,6 +30,8 @@ no_std:
 deku = { version = "0.16", default-features = false, features = ["alloc"] }
 ```
 
+*Compiler support: requires rustc 1.65+*
+
 ## Example
 
 See [documentation](https://docs.rs/deku) or
@@ -51,8 +53,9 @@ struct DekuTest {
 }
 
 fn main() {
-    let data: Vec<u8> = vec![0b0110_1001, 0xBE, 0xEF];
-    let (_rest, mut val) = DekuTest::from_bytes((data.as_ref(), 0)).unwrap();
+    let data: &[u8] = &[0b0110_1001, 0xBE, 0xEF];
+    let mut cursor = Cursor::new(data);
+    let (_amt_read, mut val) = DekuTest::from_reader((&mut cursor, 0)).unwrap();
     assert_eq!(DekuTest {
         field_a: 0b0110,
         field_b: 0b1001,