Fix misleading NamedPipeServer example #6590
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
The previous NamedPipeServer doc example seemed to imply that the return type of `NamedPipeServer::connect()` was a `Future<Result<some_kind_of_client>>>`, however, `connect()` returns a `Future<Result<()>>>`. The following line of code reopening the pipe would shadow the newly connected pipe immediately, making the following spawned task pointless. Hopefully these changes make it more clear what should be happening in the example.
Darksonn
added
T-docs
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.
Motivation
The previous NamedPipeServer doc example seemed to imply that the return type of
NamedPipeServer::connect()was aFuture<Result<some_kind_of_client>>>, however,connect()returns aFuture<Result<()>>>. The following line of code reopening the pipe would shadow the newly connected pipe immediately, making the following spawned task pointless.Solution
Instead, now it binds the original named pipe to a new variable after a client connects, allowing for the subsequent task to be able use the connection.