Examples: Improve Echo Example Consistency #7256
Open
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
nskins
changed the title
maminrayej
reviewed
Apr 14, 2025
Comment on lines
+44
to
+77
| mod tcp { | ||
| use bytes::Bytes; | ||
| use futures::{future, Sink, SinkExt, Stream, StreamExt}; | ||
| use std::{error::Error, io, net::SocketAddr}; | ||
| use tokio::net::TcpStream; | ||
| use tokio_util::codec::{BytesCodec, FramedRead, FramedWrite}; | ||
|
|
||
| pub async fn connect( | ||
| addr: &SocketAddr, | ||
| mut stdin: impl Stream<Item = Result<Bytes, io::Error>> + Unpin, | ||
| mut stdout: impl Sink<Bytes, Error = io::Error> + Unpin, | ||
| ) -> Result<(), Box<dyn Error>> { | ||
| let mut stream = TcpStream::connect(addr).await?; | ||
| let (r, w) = stream.split(); | ||
| let mut sink = FramedWrite::new(w, BytesCodec::new()); | ||
| // filter map Result<BytesMut, Error> stream into just a Bytes stream to match stdout Sink | ||
| // on the event of an Error, log the error and end the stream | ||
| let mut stream = FramedRead::new(r, BytesCodec::new()) | ||
| .filter_map(|i| match i { | ||
| //BytesMut into Bytes | ||
| Ok(i) => future::ready(Some(i.freeze())), | ||
| Err(e) => { | ||
| println!("failed to read from socket; error={e}"); | ||
| future::ready(None) | ||
| } | ||
| }) | ||
| .map(Ok); | ||
|
|
||
| match future::join(sink.send_all(&mut stdin), stdout.send_all(&mut stream)).await { | ||
| (Err(e), _) | (_, Err(e)) => Err(e.into()), | ||
| _ => Ok(()), | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Now that the code for TCP and UDP are moved to separate files, I think it makes sense to remove the mod tcp and move the use statements to the top of the file.
| } | ||
| } | ||
| } | ||
|
|
||
| mod udp { |
There was a problem hiding this comment.
Same thing as connect-tcp.rs here.
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
This addresses the suggestion brought up in #7250.
Solution
This PR splits up
connect.rsinto two separate programs:connect-tcp.rsandconnect-udp.rs. This matches the echo examples which are split up by protocol already. This should improve readability and ease of understanding so end users only need to consider one protocol at a time.Additionally, documentation referencing these new example names has been updated appropriately. I tested these changes by running all examples that interact with these files and verifying that the behavior is the same as before.