Correct and expand the WebSockets documentation#79
Merged
Vectornaut merged 1 commit intomainfrom Apr 14, 2026
Merged
Conversation
levkk
approved these changes
Apr 14, 2026
Collaborator
Author
Correct some errors that prevented the WebSockets sample code from compiling. Expand the testing instructions to confirm that the echo server is working as intended.
7b03707 to
b1061d0
Compare
Collaborator
Author
|
Rebased onto #81; continuous integration checks now pass! Merging. |
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
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.
Summary
The branch to be merged corrects some errors that prevented the WebSockets sample code from compiling.
Changes
Corrections
The errors corrected include the ones described in issue #77, which affect the code in the "Writing a WebSocket controller" section.
They also include an additional error in the "Starting a WebSocket server" section; the code from this section is needed to build a runnable program.
Expansion
The branch to be merged also expands the testing instructions to confirm that the echo server is working as intended.
Validation
I've checked my changes using the following process.
Start a new crate with the following
Cargo.toml.Copy the code from the corrected documentation sections into
src/main.rs.Start the server with
cargo runand then follow the expanded testing instructions from the documentation.