Make PublishBuilder::packet_id() take an Option #50
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since the packet ID is optional in a PUBLISH packet depending on the QoS, adapter functions that construct a PUBLISH packet may need to conditionally insert a packet ID. With the current builder method, this is not ergonomic -- the user must create a mutable binding for the builder and conditionally call the `packet_id()` method. By changing the method to take an Option, the user can unconditionally call the method and avoid interrupting the builder pattern. See the simplification in `examples/publish.rs` as an example.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #50 +/- ##
=======================================
Coverage 90.90% 90.90%
=======================================
Files 55 55
Lines 7456 7456
=======================================
Hits 6778 6778
Misses 678 678
🚀 New features to boost your workflow:
|
Owner
|
I understand your requirement. However, this PR introduces a breaking change. |
Contributor
Author
|
Closing in favor of #53 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since the packet ID is optional in a PUBLISH packet depending on the QoS, adapter functions that construct a PUBLISH packet may need to conditionally insert a packet ID. With the current builder method, this is not ergonomic -- the user must create a mutable binding for the builder and conditionally call the
packet_id()method. By changing the method to take an Option, the user can unconditionally call the method and avoid interrupting the builder pattern. See the simplification inexamples/publish.rsas an example.This is a suggestion for a minor API change. It makes certain use cases nicer to implement (mine looks similar to the example, adapting from another library that generates MQTT messages at multiple QoS levels), but maybe the extra
Someis not as nice when the QoS is known at compile time. An alternative would be to a new method that takes theOption.