diff options
| author | Corey Farwell <coreyf@rwell.org> | 2016-09-13 22:07:38 -0400 |
|---|---|---|
| committer | Corey Farwell <coreyf@rwell.org> | 2016-09-13 22:07:38 -0400 |
| commit | fae439b92f68a67444814243d4951943a43b0273 (patch) | |
| tree | fa11bac63da73c3a26cfbaf4f544fa07fc519d19 /src/libstd/net | |
| parent | b1363a73ede57ae595f3a1be2bb75d308ba4f7f6 (diff) | |
| download | rust-fae439b92f68a67444814243d4951943a43b0273.tar.gz rust-fae439b92f68a67444814243d4951943a43b0273.zip | |
Add doc examples for std::net::IpAddr construction.
Diffstat (limited to 'src/libstd/net')
| -rw-r--r-- | src/libstd/net/ip.rs | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/libstd/net/ip.rs b/src/libstd/net/ip.rs index c6a7a77e68a..05ef559422f 100644 --- a/src/libstd/net/ip.rs +++ b/src/libstd/net/ip.rs @@ -22,6 +22,24 @@ use sys::net::netc as c; use sys_common::{AsInner, FromInner}; /// An IP address, either an IPv4 or IPv6 address. +/// +/// # Examples +/// +/// Constructing an IPv4 address: +/// +/// ``` +/// use std::net::{IpAddr, Ipv4Addr}; +/// +/// IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)); +/// ``` +/// +/// Constructing an IPv6 address: +/// +/// ``` +/// use std::net::{IpAddr, Ipv6Addr}; +/// +/// IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)); +/// ``` #[stable(feature = "ip_addr", since = "1.7.0")] #[derive(Copy, Clone, Eq, PartialEq, Debug, Hash, PartialOrd, Ord)] pub enum IpAddr { |