net: fix misleading NamedPipeServer example (#6590)

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.
This commit is contained in:
Maxwell Borden 2024-05-26 12:25:19 +02:00 committed by GitHub
parent 3a6fdc0568
commit 6c42d286b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -75,7 +75,8 @@ use self::doc::*;
/// let server = tokio::spawn(async move {
/// loop {
/// // Wait for a client to connect.
/// let connected = server.connect().await?;
/// server.connect().await?;
/// let connected_client = server;
///
/// // Construct the next server to be connected before sending the one
/// // we already have of onto a task. This ensures that the server