Unix socket doc #38236

GuillaumeGomez · 2016-12-08T05:56:16Z

frewsxcv · 2016-12-08T06:57:23Z

src/libstd/sys/unix/ext/net.rs

+///
+/// ```
+///
+/// ```


This example doesn't seem particularly helpful :)

nagisa · 2016-12-08T17:16:26Z

src/libstd/sys/unix/ext/net.rs

+    /// ```
+    /// use std::os::unix::net::UnixListener;
+    ///
+    /// let socket = match UnixListener::bind("/tmp/sock") {


IMHO every single example exhaustively matching on socket creation is sort of overzealous.

if let Ok(socket) = UnixListener::bind("/tmp/sock") { // show off the feature }

would be a much better alternative IMO.

EDIT: exhaustive matching is fine on the examples of functions that do the actual socket creation, though.

I think I'll just go for unwrap for the other cases.

nagisa · 2016-12-08T17:18:31Z

src/libstd/sys/unix/ext/net.rs

+    /// ```no_run
+    /// use std::os::unix::net::UnixStream;
+    ///
+    /// let socket = match UnixStream::connect("/tmp/sock") {


unused variable :)

I don't see it as an issue here, on the opposite. The point is to show people how it works, and creating a (unused) variable helps it.

nagisa · 2016-12-08T17:20:02Z

src/libstd/sys/unix/ext/net.rs

+    /// let (sock1, sock2) = match UnixStream::pair() {
+    ///     Ok((sock1, sock2)) => (sock1, sock2),
+    ///     Err(e) => {
+    ///         println!("Couldn't connect: {:?}", e);


Couldn’t create a pair of sockets.

GuillaumeGomez · 2016-12-08T18:10:55Z

Updated.

GuillaumeGomez · 2016-12-09T07:24:12Z

And urls fixed as well. Build fails but doesn't have errors so I guess it's okay?

frewsxcv

Looks good, just a few comments 🎊

frewsxcv · 2016-12-09T07:40:33Z

src/libstd/sys/unix/ext/net.rs

+    /// use std::os::unix::net::UnixStream;
+    ///
+    /// let socket = UnixStream::connect("/tmp/sock").unwrap();
+    /// socket.set_nonblocking(true).expect("Couldn't set non blocking");


Nit: 'nonblocking' is one word

frewsxcv · 2016-12-09T07:46:03Z

src/libstd/sys/unix/ext/net.rs

+    /// use std::os::unix::net::UnixDatagram;
+    ///
+    /// let sock = UnixDatagram::unbound().unwrap();
+    /// sock.send_to(b"omelette AU fromage", "/some/sock").expect("send_to function failed");


Nit: why is "AU" capitalized?

To help english people improve their french. :p

For me, a person who doesn't know any French, it doesn't help me learn French, it just makes me confused :)

Haha. Well, I'll "fixed" it then.

frewsxcv · 2016-12-09T07:46:36Z

src/libstd/sys/unix/ext/net.rs

+    ///
+    /// let sock = UnixDatagram::unbound().unwrap();
+    /// sock.connect("/some/sock").expect("Couldn't connect");
+    /// sock.send(b"omelette AU fromage").expect("send_to function failed");


frewsxcv · 2016-12-09T07:47:17Z

src/libstd/sys/unix/ext/net.rs

+    /// let socket = UnixListener::bind("/tmp/sock").unwrap();
+    /// let addr = socket.local_addr().expect("Couldn't get local address");
+    /// assert_eq!(addr.is_unnamed(), false);
+    /// ```


Can we add an example here where is_unnamed() is true?

frewsxcv · 2016-12-09T07:49:30Z

src/libstd/sys/unix/ext/net.rs

+    /// let socket = UnixListener::bind("/tmp/sock").unwrap();
+    /// let addr = socket.local_addr().expect("Couldn't get local address");
+    /// assert_eq!(addr.as_pathname(), Some(Path::new("/tmp/sock")));
+    /// ```


Same here. If we can create an unnamed socket, can we show here that as_pathname() is None?

GuillaumeGomez · 2016-12-12T10:49:13Z

Updated.

frewsxcv

r=me unless you want to address the nits

frewsxcv · 2016-12-12T20:46:12Z

src/libstd/sys/unix/ext/net.rs

+    /// let addr = socket.local_addr().expect("Couldn't get local address");
+    /// assert_eq!(addr.is_unnamed(), false);
+    ///
+    /// // with is_unnamed() as true now:


Nit: Alternatively, you could also do something like this:

# Examples An unnamed address: ``` ... ``` A named address: ``` ... ```

Oh good point!

frewsxcv · 2016-12-12T20:48:17Z

src/libstd/sys/unix/ext/net.rs

+    /// use std::os::unix::net::UnixStream;
+    ///
+    /// let socket = UnixStream::connect("/tmp/sock").unwrap();
+    /// let sock_copy = socket.try_clone().expect("Couldn't clone socket...");


Nit: The ellipsis here doesn't seem necessary.

The ellipsis? What do you mean? The expect call?

...

https://en.wikipedia.org/wiki/Ellipsis

GuillaumeGomez · 2016-12-13T12:52:35Z

I addressed the nits.

frewsxcv · 2016-12-13T15:22:17Z

src/libstd/sys/unix/ext/net.rs

+    /// let addr = socket.local_addr().expect("Couldn't get local address");
+    /// assert_eq!(addr.as_pathname(), Some(Path::new("/tmp/sock")));
+    ///
+    /// // with as_pathname() as true now:


Did you want to do the same thing here?

frewsxcv · 2016-12-13T15:32:15Z

r=me unless you want to address that comment

GuillaumeGomez · 2016-12-13T15:56:54Z

And updated too.

frewsxcv · 2016-12-13T15:58:27Z

@bors r+ rollup 🎉

bors · 2016-12-13T15:58:28Z

📌 Commit cc180fb has been approved by frewsxcv

@frewsxcv

…rewsxcv Unix socket doc r? @frewsxcv

frewsxcv · 2016-12-16T00:22:00Z

@bors r-

Errors: #38387 (comment)

GuillaumeGomez · 2016-12-16T10:15:08Z

And fixed. I re-r+ if you don't mind @frewsxcv.

@bors: r=frewsxcv

bors · 2016-12-16T10:15:10Z

📌 Commit 2938e6a has been approved by frewsxcv

@frewsxcv

…rewsxcv Unix socket doc r? @frewsxcv

bors · 2016-12-16T11:54:30Z

⌛ Testing commit 2938e6a with merge 1ca362c...

bors · 2016-12-16T11:56:50Z

💔 Test failed - auto-mac-64-opt-rustbuild

GuillaumeGomez · 2016-12-16T15:48:30Z

@bors: retry

bors · 2016-12-16T15:57:29Z

⌛ Testing commit 2938e6a with merge 92039a2...

bors · 2016-12-16T15:59:50Z

💔 Test failed - auto-mac-64-opt-rustbuild

alexcrichton · 2016-12-16T17:26:15Z

@bors: retry

…

On Fri, Dec 16, 2016 at 7:59 AM, bors ***@***.***> wrote: 💔 Test failed - auto-mac-64-opt-rustbuild <https://buildbot.rust-lang.org/builders/auto-mac-64-opt-rustbuild/builds/3277> — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#38236 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAD95AkNg-hoR9IvK-BHpnHYUbjLkOxUks5rIrV4gaJpZM4LHd2K> .

@frewsxcv

…rewsxcv Unix socket doc r? @frewsxcv

sanxiyn · 2016-12-19T15:49:45Z

@bors retry

alexcrichton · 2016-12-20T18:40:54Z

@bors: retry

@frewsxcv

…rewsxcv Unix socket doc r? @frewsxcv

Rollup of 29 pull requests - Successful merges: #37761, #38006, #38131, #38150, #38158, #38171, #38208, #38215, #38236, #38245, #38289, #38302, #38315, #38346, #38388, #38395, #38398, #38418, #38432, #38451, #38463, #38468, #38470, #38471, #38472, #38478, #38486, #38493, #38498 - Failed merges: #38271, #38483

rust-highfive assigned frewsxcv Dec 8, 2016

frewsxcv reviewed Dec 8, 2016

View reviewed changes

nagisa reviewed Dec 8, 2016

View reviewed changes

GuillaumeGomez added 4 commits December 8, 2016 09:38

Add missing doc examples for SocketAddr struct

9976f5f

Add doc examples for UnixStream

7fe17f9

Add UnixListener doc examples

c35b9f6

Add Incoming doc examples

a78a33c

GuillaumeGomez force-pushed the unix_socket_doc branch from 6c5046c to 878341f Compare December 8, 2016 18:08

GuillaumeGomez force-pushed the unix_socket_doc branch 2 times, most recently from 477ba42 to fdbd760 Compare December 9, 2016 06:28

frewsxcv reviewed Dec 9, 2016

View reviewed changes

GuillaumeGomez force-pushed the unix_socket_doc branch from fdbd760 to 6011527 Compare December 12, 2016 10:48

frewsxcv approved these changes Dec 12, 2016

View reviewed changes

GuillaumeGomez force-pushed the unix_socket_doc branch from 6011527 to 2979946 Compare December 13, 2016 12:52

frewsxcv reviewed Dec 13, 2016

View reviewed changes

GuillaumeGomez force-pushed the unix_socket_doc branch from 2979946 to cc180fb Compare December 13, 2016 15:56

GuillaumeGomez mentioned this pull request Dec 15, 2016

Rollup of 6 pull requests #38387

Closed

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Dec 15, 2016

Rollup merge of rust-lang#38236 - GuillaumeGomez:unix_socket_doc, r=f…

f671b7a

…rewsxcv Unix socket doc r? @frewsxcv

Add missing doc examples for UnixDatagram

2938e6a

GuillaumeGomez force-pushed the unix_socket_doc branch from cc180fb to 2938e6a Compare December 16, 2016 10:14

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Dec 16, 2016

Rollup merge of rust-lang#38236 - GuillaumeGomez:unix_socket_doc, r=f…

269978e

…rewsxcv Unix socket doc r? @frewsxcv

GuillaumeGomez mentioned this pull request Dec 16, 2016

Rollup of 7 pull requests #38407

Closed

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Dec 18, 2016

Rollup merge of rust-lang#38236 - GuillaumeGomez:unix_socket_doc, r=f…

1b90f83

…rewsxcv Unix socket doc r? @frewsxcv

GuillaumeGomez mentioned this pull request Dec 18, 2016

Rollup of 9 pull requests #38450

Closed

alexcrichton added a commit to alexcrichton/rust that referenced this pull request Dec 20, 2016

Rollup merge of rust-lang#38236 - GuillaumeGomez:unix_socket_doc, r=f…

4cfb2b4

…rewsxcv Unix socket doc r? @frewsxcv

alexcrichton mentioned this pull request Dec 20, 2016

Rollup of 29 pull requests #38499

Merged

bors merged commit 2938e6a into rust-lang:master Dec 21, 2016

GuillaumeGomez deleted the unix_socket_doc branch December 21, 2016 16:37

Unix socket doc #38236

Unix socket doc #38236

Conversation

GuillaumeGomez commented Dec 8, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nagisa Dec 8, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nagisa Dec 8, 2016 • edited Loading

Choose a reason for hiding this comment

GuillaumeGomez commented Dec 8, 2016

GuillaumeGomez commented Dec 9, 2016

frewsxcv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Dec 12, 2016

frewsxcv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Dec 13, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frewsxcv commented Dec 13, 2016

GuillaumeGomez commented Dec 13, 2016

frewsxcv commented Dec 13, 2016

bors commented Dec 13, 2016

frewsxcv commented Dec 16, 2016

GuillaumeGomez commented Dec 16, 2016

bors commented Dec 16, 2016

bors commented Dec 16, 2016

bors commented Dec 16, 2016

GuillaumeGomez commented Dec 16, 2016

bors commented Dec 16, 2016

bors commented Dec 16, 2016

alexcrichton commented Dec 16, 2016 via email

sanxiyn commented Dec 19, 2016

alexcrichton commented Dec 20, 2016

nagisa Dec 8, 2016 •

edited

Loading

nagisa Dec 8, 2016 •

edited

Loading