refactor framing_sv2 example
#1468
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1468 +/- ##
=======================================
Coverage 21.92% 21.92%
=======================================
Files 135 135
Lines 9573 9573
=======================================
Hits 2099 2099
Misses 7474 7474
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
plebhash
force-pushed
the
refactor-framing-sv2-example
branch
5 times, most recently
from
7d24f3f to
52e824f
Compare
plebhash
changed the title
framing_sv2 exampleframing_sv2 example
nice catch, we didn't but I just added a commit that runs it from |
Should we also add other examples that we recently included during our documentation efforts, since not all of them have been added to CI? |
|
|
||
| // Example message type (e.g., SetupConnection) | ||
| const MSG_TYPE: u8 = 1; | ||
| // Example extension type (e.g., a standard Sv2 message) | ||
| const EXT_TYPE: u16 = 0x0001; | ||
|
|
||
| #[derive(Serialize, Debug)] | ||
| #[derive(Serialize, Deserialize, Debug, Clone)] | ||
| pub struct CustomMessage { |
There was a problem hiding this comment.
thinking out loud here, wouldn't it be more beneficial to actually have an SV2 message here? for the MSG_TYPE, SETUP_CONNECTION is used, maybe here as well?
There was a problem hiding this comment.
rationale here is to limit this example to the scope of framing_sv2 while highlighting the assumption that the crate is agnostic to which messages actually exist in the Sv2 protocol
it's meant to showcase that as long as a message is defined this way, framing_sv2 will be able to transmit it over the wire (without any kind of assertion of whether this message is part of the spec or not)
plebhash
force-pushed
the
refactor-framing-sv2-example
branch
from
cd6226b to
cb2b67b
Compare
|
This should be good to go now? cc: @plebhash |
|
I think this PR is ready to go since it received 2 approvals. Could you try to rebase it @plebhash ? |
plebhash
force-pushed
the
refactor-framing-sv2-example
branch
from
cb2b67b to
5de3953
Compare
we need to assert that the deserialized message has the same content from the original
pavlenex
force-pushed
the
refactor-framing-sv2-example
branch
from
5de3953 to
a999706
Compare
close #1467