feat!: support multiple arguments to the payload #384
Merged
Conversation
This file contains 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
Added new payload variant to support multiple arguments. The old Payload::String is deprecated, and will be removed shortly. Also fixed running doc tests in the devcontainer
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #384 +/- ##
==========================================
+ Coverage 90.78% 91.39% +0.61%
==========================================
Files 37 37
Lines 4708 4837 +129
==========================================
+ Hits 4274 4421 +147
+ Misses 434 416 -18 ☔ View full report in Codecov by Sentry. |
1c3t3a
approved these changes
Dec 6, 2023
socketio/examples/async.rs
Outdated
| @@ -14,8 +14,11 @@ async fn main() { | |||
| let callback = |payload: Payload, socket: Client| { | |||
| async move { | |||
| match payload { | |||
| Payload::String(str) => println!("Received: {}", str), | |||
| Payload::Text(values) => println!("Received: {:?}", values), | |||
There was a problem hiding this comment.
nit: maybe switch formatting to {:#?} to be consistent with how we format bytes in the next line?
socketio/examples/callback.rs
Outdated
| @@ -11,8 +11,11 @@ fn main() { | |||
| // socket to communicate with the server | |||
| let handle_test = |payload: Payload, socket: RawClient| { | |||
| match payload { | |||
| Payload::String(str) => println!("Received string: {}", str), | |||
| Payload::Text(text) => println!("Received json: {:?}", text), | |||
There was a problem hiding this comment.
nit: maybe switch formatting to {:#?} to be consistent with how we format bytes in the next line?
socketio/examples/readme.rs
Outdated
| Payload::String(str) => println!("Received: {}", str), | ||
| Payload::Text(text) => println!("Received json: {:?}", text), |
There was a problem hiding this comment.
nit: Same as the others, maybe switch to {:#?}?
| @@ -48,8 +48,10 @@ impl ClientBuilder { | |||
| /// let callback = |payload: Payload, socket: Client| { | |||
| /// async move { | |||
| /// match payload { | |||
| /// Payload::String(str) => println!("Received: {}", str), | |||
| /// Payload::Text(values) => println!("Received: {:?}", values), | |||
| @@ -112,8 +114,10 @@ impl ClientBuilder { | |||
| /// .on("test", |payload: Payload, _| { | |||
| /// async move { | |||
| /// match payload { | |||
| /// Payload::String(str) => println!("Received: {}", str), | |||
| /// Payload::Binary(bin_data) => println!("Received bytes: {:#?}", bin_data), | |||
| /// Payload::Text(values) => println!("Received: {:?}", values), | |||
| @@ -456,6 +457,8 @@ mod test { | |||
| .on("test", |msg, _| { | |||
| async { | |||
| match msg { | |||
| Payload::Text(values) => println!("Received json: {:?}", values), | |||
There was a problem hiding this comment.
nit: same. Note to myself: we really do format that a lot...
| println!("Ack data: {}", str); | ||
| if let Payload::Text(json) = message { | ||
| println!("Received json Ack"); | ||
| println!("Ack data: {:?}", json); |
| if let Payload::String(str) = payload { | ||
| println!("{event}: {str}"); | ||
| if let Payload::Text(values) = payload { | ||
| println!("{event}: {values:?}"); |
| /// Returns a packet for a payload, could be used for both binary and non binary | ||
| /// events and acks. Convenience method. | ||
| #[inline] | ||
| pub(crate) fn new_from_payload<'a>( |
There was a problem hiding this comment.
Maybe just name it new?
We take way more than just the payload to create it.
There was a problem hiding this comment.
There's a different new with args down here:
rust-socketio/socketio/src/packet.rs
Line 70 in 38f20fc
Closed
shenjackyuanjie
added a commit
to shenjackyuanjie/rust-socketio
that referenced
this pull request
Dec 11, 2023
shenjackyuanjie
added a commit
to shenjackyuanjie/rust-socketio
that referenced
this pull request
Dec 11, 2023
shenjackyuanjie
added a commit
to shenjackyuanjie/rust-socketio
that referenced
this pull request
Dec 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added new payload variant called
Textto support multiple arguments encoded in JSON. The old Payload::String is deprecated, and will be removed shortly. UsePayload::from(String)to mimic old behaviorBuilt on top of @SalahaldinBilal 's work #379
Also fixed running doc tests in the devcontainer