Add packable BTreeSet impls and BTreeSetPrefix (#69)

* Add BTreeSet impls and BTreeSetPrefix * version * fix derive package * fix feature gates * add tests and cleanup features * Fix tests * more feature refactors * docs * nits * oop * copyrights * comment * Fix test --------- Co-authored-by: Thibault Martinez <thibault@iota.org>
iotaledger · Sep 15, 2023 · cfea534 · cfea534
1 parent b3089cf
commit cfea534
Show file tree

Hide file tree

Showing 96 changed files with 577 additions and 163 deletions.
diff --git a/packable/packable-derive-test/Cargo.toml b/packable/packable-derive-test/Cargo.toml
@@ -16,7 +16,7 @@ name = "tests"
 path = "tests/lib.rs"
 
 [dev-dependencies]
-packable = { version = "=0.8.1", path = "../packable", default-features = false }
+packable = { version = "=0.8.2", path = "../packable", default-features = false }
 
 rustversion = { version = "1.0.9", default-features = false }
 trybuild = { version = "1.0.71", default-features = false, features = [ "diff" ] }

diff --git a/packable/packable-derive-test/src/lib.rs b/packable/packable-derive-test/src/lib.rs
@@ -1,2 +1,2 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
diff --git a/packable/packable-derive-test/tests/fail/duplicated_tag_enum.rs b/packable/packable-derive-test/tests/fail/duplicated_tag_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports, unreachable_patterns)]
 
-use packable::{error::UnknownTagError, Packable};
-
 use core::convert::Infallible;
 
+use packable::{error::UnknownTagError, Packable};
+
 #[derive(Packable)]
 #[packable(tag_type = u8)]
 #[packable(unpack_error = UnknownTagError<u8>)]

diff --git a/packable/packable-derive-test/tests/fail/incorrect_tag_enum.rs b/packable/packable-derive-test/tests/fail/incorrect_tag_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::{error::UnknownTagError, Packable};
-
 use core::convert::Infallible;
 
+use packable::{error::UnknownTagError, Packable};
+
 #[derive(Packable)]
 #[packable(tag_type = u8)]
 #[packable(unpack_error = UnknownTagError<u8>)]

diff --git a/packable/packable-derive-test/tests/fail/invalid_field_type_verify_with.rs b/packable/packable-derive-test/tests/fail/invalid_field_type_verify_with.rs
@@ -1,18 +1,17 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
+use core::convert::Infallible;
+
 use packable::{
-    error::UnpackErrorExt,
-    error::{UnknownTagError, UnpackError},
+    error::{UnknownTagError, UnpackError, UnpackErrorExt},
     packer::Packer,
     unpacker::Unpacker,
     Packable,
 };
 
-use core::convert::Infallible;
-
 #[derive(Debug)]
 pub struct PickyError(u8);
 

diff --git a/packable/packable-derive-test/tests/fail/invalid_field_type_verify_with.stderr b/packable/packable-derive-test/tests/fail/invalid_field_type_verify_with.stderr
@@ -1,7 +1,7 @@
 error[E0308]: mismatched types
-  --> tests/fail/invalid_field_type_verify_with.rs:33:10
+  --> tests/fail/invalid_field_type_verify_with.rs:32:10
    |
-33 | #[derive(Packable)]
+32 | #[derive(Packable)]
    |          ^^^^^^^^
    |          |
    |          expected `&u64`, found `&u8`
@@ -10,8 +10,8 @@ error[E0308]: mismatched types
    = note: expected reference `&u64`
               found reference `&u8`
 note: function defined here
-  --> tests/fail/invalid_field_type_verify_with.rs:25:4
+  --> tests/fail/invalid_field_type_verify_with.rs:24:4
    |
-25 | fn verify_value<const VERIFY: bool>(&value: &u64, _: &()) -> Result<(), PickyError> {
+24 | fn verify_value<const VERIFY: bool>(&value: &u64, _: &()) -> Result<(), PickyError> {
    |    ^^^^^^^^^^^^                     ------------
    = note: this error originates in the derive macro `Packable` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/packable/packable-derive-test/tests/fail/invalid_packable_with.rs b/packable/packable-derive-test/tests/fail/invalid_packable_with.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unpack_error = Impossible, with = Impossible::new)]
 pub struct Point {

diff --git a/packable/packable-derive-test/tests/fail/invalid_tag_enum.rs b/packable/packable-derive-test/tests/fail/invalid_tag_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::{error::UnknownTagError, Packable};
-
 use core::convert::Infallible;
 
+use packable::{error::UnknownTagError, Packable};
+
 #[derive(Packable)]
 #[packable(tag_type = u8)]
 #[packable(unpack_error = UnknownTagError<u8>)]

diff --git a/packable/packable-derive-test/tests/fail/invalid_tag_type_enum.rs b/packable/packable-derive-test/tests/fail/invalid_tag_type_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(tag_type = [u8; 32])]
 #[packable(unpack_error = Infallible)]

diff --git a/packable/packable-derive-test/tests/fail/invalid_unpack_error_type.rs b/packable/packable-derive-test/tests/fail/invalid_unpack_error_type.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unpack_error = 1)]
 pub struct Point {

diff --git a/packable/packable-derive-test/tests/fail/missing_discriminant.rs b/packable/packable-derive-test/tests/fail/missing_discriminant.rs
@@ -1,4 +1,4 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]

diff --git a/packable/packable-derive-test/tests/fail/missing_tag_enum.rs b/packable/packable-derive-test/tests/fail/missing_tag_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(tag_type = u32)]
 #[packable(unpack_error = Infallible)]

diff --git a/packable/packable-derive-test/tests/fail/missing_tag_type_enum.rs b/packable/packable-derive-test/tests/fail/missing_tag_type_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unpack_error = Infallible)]
 pub enum OptI32 {

diff --git a/packable/packable-derive-test/tests/fail/overlapping_discriminant.rs b/packable/packable-derive-test/tests/fail/overlapping_discriminant.rs
@@ -1,4 +1,4 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports, unreachable_patterns)]

diff --git a/packable/packable-derive-test/tests/fail/packable_is_structural.rs b/packable/packable-derive-test/tests/fail/packable_is_structural.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 struct NonPackable;
 
 #[derive(Packable)]

diff --git a/packable/packable-derive-test/tests/fail/packable_is_structural.stderr b/packable/packable-derive-test/tests/fail/packable_is_structural.stderr
@@ -5,13 +5,13 @@ error[E0277]: the trait bound `NonPackable: packable::Packable` is not satisfied
    |          ^^^^^^^^ the trait `packable::Packable` is not implemented for `NonPackable`
    |
    = help: the following other types implement trait `packable::Packable`:
-             (A, B)
-             (A, B, C)
-             (A, B, C, D)
-             (A, B, C, D, E)
-             (A, B, C, D, E, F)
-             (A, B, C, D, E, F, G)
-             (A, B, C, D, E, F, G, H)
-             (A, B, C, D, E, F, G, H, I)
-           and 28 others
+             bool
+             i8
+             i16
+             i32
+             i64
+             i128
+             u8
+             u16
+           and $N others
    = note: this error originates in the derive macro `Packable` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/packable/packable-derive-test/tests/fail/union.rs b/packable/packable-derive-test/tests/fail/union.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unpack_error = Infallible)]
 pub union MaybeInt {

diff --git a/packable/packable-derive-test/tests/fail/unknown_ident.rs b/packable/packable-derive-test/tests/fail/unknown_ident.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unknown_ident = true)]
 pub struct Unit;

diff --git a/packable/packable-derive-test/tests/lib.rs b/packable/packable-derive-test/tests/lib.rs
@@ -1,4 +1,4 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 use std::{ffi::OsStr, fs::read_dir, path::Path};
@@ -60,4 +60,4 @@ macro_rules! make_test {
 #[rustversion::stable]
 make_test!();
 #[rustversion::not(stable)]
-make_test!(packable_is_structural);
+make_test!();
diff --git a/packable/packable-derive-test/tests/pass/default_errors.rs b/packable/packable-derive-test/tests/pass/default_errors.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::{error::UnknownTagError, Packable};
-
 use core::{any::TypeId, convert::Infallible};
 
+use packable::{error::UnknownTagError, Packable};
+
 #[derive(Packable)]
 pub struct Point {
     x: i32,

diff --git a/packable/packable-derive-test/tests/pass/enum_discriminant.rs b/packable/packable-derive-test/tests/pass/enum_discriminant.rs
@@ -1,4 +1,4 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 use packable::{Packable, PackableExt};

diff --git a/packable/packable-derive-test/tests/pass/error_coercion.rs b/packable/packable-derive-test/tests/pass/error_coercion.rs
@@ -1,18 +1,17 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
+use core::convert::Infallible;
+
 use packable::{
-    error::UnpackErrorExt,
-    error::{UnknownTagError, UnpackError},
+    error::{UnknownTagError, UnpackError, UnpackErrorExt},
     packer::Packer,
     unpacker::Unpacker,
     Packable,
 };
 
-use core::convert::Infallible;
-
 pub struct Picky(u8);
 
 #[derive(Debug)]

diff --git a/packable/packable-derive-test/tests/pass/generic_newtype.rs b/packable/packable-derive-test/tests/pass/generic_newtype.rs
@@ -1,4 +1,4 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]

diff --git a/packable/packable-derive-test/tests/pass/mixed_enum.rs b/packable/packable-derive-test/tests/pass/mixed_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::{error::UnknownTagError, Packable};
-
 use core::convert::Infallible;
 
+use packable::{error::UnknownTagError, Packable};
+
 #[derive(Packable)]
 #[packable(tag_type = u8)]
 #[packable(unpack_error = UnknownTagError<u8>)]

diff --git a/packable/packable-derive-test/tests/pass/named_enum.rs b/packable/packable-derive-test/tests/pass/named_enum.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::{error::UnknownTagError, Packable};
-
 use core::convert::Infallible;
 
+use packable::{error::UnknownTagError, Packable};
+
 #[derive(Packable)]
 #[packable(tag_type = u8)]
 #[packable(unpack_error = UnknownTagError<u8>)]

diff --git a/packable/packable-derive-test/tests/pass/named_struct.rs b/packable/packable-derive-test/tests/pass/named_struct.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unpack_error = Infallible)]
 pub struct Point {

diff --git a/packable/packable-derive-test/tests/pass/newtype.rs b/packable/packable-derive-test/tests/pass/newtype.rs
@@ -1,12 +1,12 @@
-// Copyright 2021-2022 IOTA Stiftung
+// Copyright 2023 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
 #![allow(unused_imports)]
 
-use packable::Packable;
-
 use core::convert::Infallible;
 
+use packable::Packable;
+
 #[derive(Packable)]
 #[packable(unpack_error = Infallible)]
 pub struct Num(u32);