Merge pull request #42 from YuhanLiin/editions

Add Editions support

Author: YuhanLiin

.github/workflows/ci.yml

@@ -19,6 +19,7 @@ jobs:
       - uses: arduino/setup-protoc@v3
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: '27.x'
       - run: cargo clippy --workspace --tests --no-default-features --exclude arm-app -- -Dwarnings
       - run: cargo clippy --workspace --tests --all-features --exclude arm-app -- -Dwarnings
       - run: cargo test --workspace --exclude arm-app
@@ -39,6 +40,7 @@ jobs:
       - uses: arduino/setup-protoc@v3
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: '27.x'
       - run: cargo build --workspace --exclude no-panicking --exclude arm-app
       - run: cargo build -p no-panicking --profile release-lto
       # Check if descriptor.rs has been bootstrapped properly
@@ -61,6 +63,7 @@ jobs:
       - uses: arduino/setup-protoc@v3
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: '27.x'
       - run: cd examples/arm-app && cargo build --profile release-lto --target thumbv7em-none-eabihf
 
   miri:
@@ -74,6 +77,7 @@ jobs:
       - uses: arduino/setup-protoc@v3
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+          version: '27.x'
       - run: MIRIFLAGS=-"Zmiri-tree-borrows" cargo +nightly miri test -p micropb -p basic-proto
 
   documentation:

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## Unreleased
+
+### Added
+
+- Protobuf Editions support
+
+### Changed
+
+- Enums now have `Debug` explicit manual impls that print the enum variant name, rather than the old derived impl that prints the variant number
+
 ## 0.6.0
 
 ### Added

Cargo.toml

@@ -14,6 +14,7 @@ members = [
     "examples/basic",
     "tests/proptest-proto",
     "tests/doc-proto",
+    "tests/editions",
 ]
 
 # For the no-panicking example

README.md

@@ -13,15 +13,21 @@ Unlike other Rust Protobuf libraries, `micropb` is aimed for constrained environ
 - Reduced memory usage for generated code, especially for optional fields.
 - Allows both statically-allocated containers ([`heapless`](https://docs.rs/heapless/latest/heapless), [`arrayvec`](https://docs.rs/arrayvec/latest/arrayvec)) or dynamically-allocated containers from [`alloc`](https://doc.rust-lang.org/alloc).
 - Code generator is highly configurable.
+- Type-safe open enums, rather than `i32`.
 - Fields can have custom handlers with user-defined encoding and decoding behaviour.
 - Supports different data sources for encoding and decoding, abstracted behind the `PbRead` and `PbWrite` traits.
 - Supports caching of message field lengths during encoding, improving performance on deeply nested message structures.
 
 #### Limitations
-- Does not support Protobuf Editions, RPC, or extensions.
+- Does not support RPC or extensions.
+- Does not support closed enums.
 - No reflection capabilities.
 - `string`, `bytes`, repeated, and `map` fields require some basic user configuration to get working.
 
+### Editions Support
+
+`micropb` supports the `field_presence` and `repeated_field_encoding` features of Protobuf Editions. The `enum_type`, `message_encoding`, and `utf8_validation` features are ignored, because `micropb` does not support customizing those features. The other standard Editions features are not relevant to code generation.
+
 ## Overview
 
 The `micropb` project consists of two crates:

examples/file-descriptor-set/build.rs

@@ -21,8 +21,14 @@ fn main() {
                 ".google.protobuf.OneofDescriptorProto",
                 ".google.protobuf.MessageOptions",
                 ".google.protobuf.EnumValueDescriptorProto",
+                ".google.protobuf.FeatureSet",
             ],
             Config::new().no_accessors(false),
+        )
+        // Need to be able to clone FeatureSet for Editions support
+        .configure(
+            ".google.protobuf.FeatureSet",
+            Config::new().no_clone_impl(false),
         );
     gen.compile_protos(&["google/protobuf/descriptor.proto"], "descriptor.rs")
         .unwrap();

micropb-gen/src/config.rs

@@ -638,10 +638,11 @@ fn substitute_param<'a>(
     t: Option<impl ToString>,
 ) -> Cow<'a, str> {
     if let Some(t) = t
-        && typestr.find(pat).is_some() {
-            let t = t.to_string();
-            return typestr.replace(pat, &t).into();
-        }
+        && typestr.find(pat).is_some()
+    {
+        let t = t.to_string();
+        return typestr.replace(pat, &t).into();
+    }
     typestr
 }