Ipv4Addr and Ipv6Addr convenience constructors. #44395

jcdyer · 2017-09-07T18:21:52Z

Introduce convenience constructors for common types.

This introduces the following constructors:

Ipv6Addr::localhost()
Ipv6Addr::unspecified()
Ipv4Addr::localhost()
Ipv4Addr::unspecified()

The recently added From implementations were nice for avoiding the fallibility of conversions from strings like "127.0.0.1".parse().unwrap(), and "::1".parse().unwrap(), but while the Ipv4 version is roughly comparable in verbosity, the Ipv6 version lacks zero-segment elision, which makes it significantly more awkward: [0, 0, 0, 0, 0, 0, 0, 0].into(). While there isn't a clear way to introduce zero elision to type that can infallibly be converted into Ipv6 addresses, this PR resolves the problem for the two most commonly used addresses, which, incidentally, are the ones that suffer the most from the lack of zero-segment elision.

This change is dead simple, and introduces no backwards incompatibility.

See also, this topic on the inernals board

rust-highfive · 2017-09-07T18:22:05Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @BurntSushi (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

estebank · 2017-09-07T20:48:40Z

src/libstd/net/ip.rs

+        assert_eq!(Ipv6Addr::unspecified(), Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));
+        assert!(Ipv6Addr::unspecified().is_unspecified());
+    }
+


Trim the trailing whitespace.

estebank · 2017-09-07T20:49:34Z

src/libstd/net/ip.rs

+    /// use std::net::Ipv4Addr;
+    ///
+    /// let addr = Ipv4Addr::localhost();
+    /// assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));


missing line closing the code example:

/// ```

estebank · 2017-09-07T20:49:43Z

src/libstd/net/ip.rs

+    /// use std::net::Ipv4Addr;
+    ///
+    /// let addr = Ipv4Addr::unspecified();
+    /// assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));


missing line closing the code example:

/// ```

estebank · 2017-09-07T20:49:47Z

src/libstd/net/ip.rs

+    /// use std::net::Ipv6Addr;
+    ///
+    /// let addr = Ipv6Addr::localhost();
+    /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));


missing line closing the code example:

/// ```

estebank · 2017-09-07T20:49:51Z

src/libstd/net/ip.rs

+    /// use std::net::Ipv6Addr;
+    ///
+    /// let addr = Ipv6Addr::unspecified();
+    /// assert_eq!(addr, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0));


missing line closing the code example:

/// ```

All resolved. Thanks.

estebank · 2017-09-08T20:48:30Z

src/libstd/net/ip.rs

+    ///
+    /// # Examples
+    ///
+    /// ```


I believe you need to add # #![feature(ip)] to this and the other new examples in order for the doc tests to work. The first # hides the line from the docs (which you might not want to do to make it clear that it is needed for this usage).

BurntSushi

This looks reasonable to me, but I think these need stability attributes, and should be unstable for now.

cc @rust-lang/libs

alexcrichton · 2017-09-14T22:46:57Z

Looks reasonable to me as well! @jcdyer mind adding the stability attributes and filing an issue to track the stability here?

jcdyer · 2017-09-15T01:34:43Z

@estebank @BurntSushi I added the unstable attributes, and created a tracking issue. I'm not entirely sure what needs to happen, but I did my best based on a quick search of other similar examples. Let me know if anything needs to be different.

alexcrichton · 2017-09-15T14:06:04Z

Looks great, thanks @jcdyer!

@bors: r+

bors · 2017-09-15T14:06:06Z

📌 Commit 9d5b0e1 has been approved by alexcrichton

alexcrichton · 2017-09-16T00:59:03Z

@bors: rollup

Ipv4Addr and Ipv6Addr convenience constructors. Introduce convenience constructors for common types. This introduces the following constructors: * Ipv6Addr::localhost() * Ipv6Addr::unspecified() * Ipv4Addr::localhost() * Ipv4Addr::unspecified() The recently added `From` implementations were nice for avoiding the fallibility of conversions from strings like `"127.0.0.1".parse().unwrap()`, and `"::1".parse().unwrap()`, but while the Ipv4 version is roughly comparable in verbosity, the Ipv6 version lacks zero-segment elision, which makes it significantly more awkward: `[0, 0, 0, 0, 0, 0, 0, 0].into()`. While there isn't a clear way to introduce zero elision to type that can infallibly be converted into Ipv6 addresses, this PR resolves the problem for the two most commonly used addresses, which, incidentally, are the ones that suffer the most from the lack of zero-segment elision. This change is dead simple, and introduces no backwards incompatibility. See also, [this topic on the inernals board](https://internals.rust-lang.org/t/pre-rfc-convenience-ip-address-constructors/5878)

Rollup of 19 pull requests - Successful merges: #44273, #44356, #44395, #44531, #44537, #44542, #44560, #44567, #44574, #44577, #44586, #44589, #44590, #44593, #44598, #44606, #44609, #44616, #44631 - Failed merges:

IP address convenience constructors

c22db3d

rust-highfive assigned BurntSushi Sep 7, 2017

estebank requested changes Sep 7, 2017

View reviewed changes

Close doc examples and trim whitespace.

ad170f2

alexcrichton added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 7, 2017

estebank reviewed Sep 8, 2017

View reviewed changes

Add feature gate to doctests.

8b6122f

jcdyer force-pushed the ip-constructors branch from 3572665 to 8b6122f Compare September 9, 2017 00:41

BurntSushi requested changes Sep 11, 2017

View reviewed changes

BurntSushi added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 11, 2017

jcdyer mentioned this pull request Sep 15, 2017

Tracking issue for IP constructors #44582

Closed

Add unstable attributes for Ipv?Addr constructors.

9d5b0e1

alexcrichton mentioned this pull request Sep 16, 2017

Rollup of 27 pull requests #44621

Closed

frewsxcv mentioned this pull request Sep 16, 2017

Rollup of 25 pull requests #44623

Closed

alexcrichton mentioned this pull request Sep 16, 2017

Rollup of 19 pull requests #44634

Merged

bors merged commit 9d5b0e1 into rust-lang:master Sep 17, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ipv4Addr and Ipv6Addr convenience constructors. #44395

Ipv4Addr and Ipv6Addr convenience constructors. #44395

jcdyer commented Sep 7, 2017 •

edited

Loading

rust-highfive commented Sep 7, 2017

estebank Sep 7, 2017

estebank Sep 7, 2017

estebank Sep 7, 2017

estebank Sep 7, 2017

estebank Sep 7, 2017

jcdyer Sep 8, 2017

estebank Sep 8, 2017

BurntSushi left a comment

alexcrichton commented Sep 14, 2017

jcdyer commented Sep 15, 2017

alexcrichton commented Sep 15, 2017

bors commented Sep 15, 2017

alexcrichton commented Sep 16, 2017

Ipv4Addr and Ipv6Addr convenience constructors. #44395

Ipv4Addr and Ipv6Addr convenience constructors. #44395

Conversation

jcdyer commented Sep 7, 2017 • edited Loading

rust-highfive commented Sep 7, 2017

estebank Sep 7, 2017

Choose a reason for hiding this comment

estebank Sep 7, 2017

Choose a reason for hiding this comment

estebank Sep 7, 2017

Choose a reason for hiding this comment

estebank Sep 7, 2017

Choose a reason for hiding this comment

estebank Sep 7, 2017

Choose a reason for hiding this comment

jcdyer Sep 8, 2017

Choose a reason for hiding this comment

estebank Sep 8, 2017

Choose a reason for hiding this comment

BurntSushi left a comment

Choose a reason for hiding this comment

alexcrichton commented Sep 14, 2017

jcdyer commented Sep 15, 2017

alexcrichton commented Sep 15, 2017

bors commented Sep 15, 2017

alexcrichton commented Sep 16, 2017

jcdyer commented Sep 7, 2017 •

edited

Loading