From: Cole Helbling <cole.e.helbling@outlook.com>
To: Alyssa Ross <hi@alyssa.is>, devel@spectrum-os.org
Subject: Re: [PATCH crosvm 2/2] sys_util: expand on UnixSeqpacket documentation
Date: Mon, 06 Jul 2020 09:24:09 -0700 [thread overview]
Message-ID: <SJ0PR03MB5581336249C463C95D83E023B3690@SJ0PR03MB5581.namprd03.prod.outlook.com> (raw)
In-Reply-To: <20200706155913.18065-2-hi@alyssa.is>
Alyssa Ross <hi@alyssa.is> writes:
> ---
> sys_util/src/net.rs | 28 +++++++++++++++++++++++++++-
> 1 file changed, 27 insertions(+), 1 deletion(-)
>
> diff --git a/sys_util/src/net.rs b/sys_util/src/net.rs
> index 82b4f5bb0..0e1cf6e55 100644
> --- a/sys_util/src/net.rs
> +++ b/sys_util/src/net.rs
> @@ -197,7 +197,9 @@ impl UnixSeqpacket {
> }
> }
>
> - /// Receive data from the socket fd to a given buffer.
> + /// Receive a message from the socket fd to a given buffer. The message will then
> + /// be removed from the socket, whether `buf` was large enough to hold all of it or
"whether or not `buf` was large enough..." sounds better, IMO.
> + /// not.
> ///
> /// # Arguments
> /// * `buf` - A mut reference to the data buffer.
> @@ -205,6 +207,30 @@ impl UnixSeqpacket {
> /// # Returns
> /// * `usize` - The size of bytes read to the buffer.
> ///
> + /// # Examples
> + ///
> + /// ```
> + /// # fn main() -> Result<(), sys_util::Error> {
> + /// # use sys_util::net::UnixSeqpacket;
> + /// let (s1, s2) = UnixSeqpacket::pair()?;
> + /// s1.send(b"First message")?;
> + /// s1.send(b"Second message")?;
> + /// s1.send(b"Third message")?;
> + ///
> + /// let mut buf = [0; 13];
> + /// assert_eq!(s2.recv(&mut buf)?, 13);
> + /// assert_eq!(&buf, b"First message");
> + ///
> + /// // Even reading into a buffer zero bytes long will consume a message.
> + /// assert_eq!(s2.recv(&mut [])?, 0);
> + ///
> + /// let mut buf = [0; 5];
> + /// assert_eq!(s2.recv(&mut buf)?, 5);
> + /// assert_eq!(&buf, b"Third");
> + /// # Ok(())
> + /// # }
> + /// ```
> + ///
> /// # Errors
> /// Returns error when `libc::recv` failed.
Returns *an* error.
> pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
> --
> 2.26.2
I love seeing docs expanded :^)
Cole
next prev parent reply other threads:[~2020-07-06 16:24 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-06 15:59 [PATCH crosvm 1/2] sys_util: make UnixSeqpacket::recv use libc::recv Alyssa Ross
2020-07-06 15:59 ` [PATCH crosvm 2/2] sys_util: expand on UnixSeqpacket documentation Alyssa Ross
2020-07-06 16:24 ` Cole Helbling [this message]
2020-07-06 23:07 ` Alyssa Ross
2020-07-06 23:14 ` [PATCH crosvm 2/2 v2] " Alyssa Ross
2020-07-06 23:22 ` Cole Helbling
2020-07-08 17:06 ` [PATCH crosvm 1/2] sys_util: make UnixSeqpacket::recv use libc::recv Cole Helbling
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=SJ0PR03MB5581336249C463C95D83E023B3690@SJ0PR03MB5581.namprd03.prod.outlook.com \
--to=cole.e.helbling@outlook.com \
--cc=devel@spectrum-os.org \
--cc=hi@alyssa.is \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://spectrum-os.org/git/crosvm
https://spectrum-os.org/git/doc
https://spectrum-os.org/git/mktuntap
https://spectrum-os.org/git/nixpkgs
https://spectrum-os.org/git/spectrum
https://spectrum-os.org/git/ucspi-vsock
https://spectrum-os.org/git/www
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).