Struct mio::Ipv4Addr [] [src]

pub struct Ipv4Addr {
    // some fields omitted
}
1.0.0

Representation of an IPv4 address.

Methods

impl Ipv4Addr

fn new(a: u8, b: u8, c: u8, d: u8) -> Ipv4Addr

Creates a new IPv4 address from four eight-bit octets.

The result will represent the IP address a.b.c.d.

fn octets(&self) -> [u8; 4]

Returns the four eight-bit integers that make up this address.

fn is_unspecified(&self) -> bool

Unstable (ip)

: extra functionality has not been scrutinized to the level that it should be stable

Returns true for the special 'unspecified' address 0.0.0.0.

1.7.0fn is_loopback(&self) -> bool

Returns true if this is a loopback address (127.0.0.0/8).

This property is defined by RFC 6890

1.7.0fn is_private(&self) -> bool

Returns true if this is a private address.

The private address ranges are defined in RFC1918 and include:

  • 10.0.0.0/8
  • 172.16.0.0/12
  • 192.168.0.0/16

Returns true if the address is link-local (169.254.0.0/16).

This property is defined by RFC 6890

fn is_global(&self) -> bool

Unstable (ip)

: extra functionality has not been scrutinized to the level that it should be stable

Returns true if the address appears to be globally routable. See iana-ipv4-special-registry.

The following return false:

  • private address (10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16)
  • the loopback address (127.0.0.0/8)
  • the link-local address (169.254.0.0/16)
  • the broadcast address (255.255.255.255/32)
  • test addresses used for documentation (192.0.2.0/24, 198.51.100.0/24 and 203.0.113.0/24)
  • the unspecified address (0.0.0.0)

1.7.0fn is_multicast(&self) -> bool

Returns true if this is a multicast address.

Multicast addresses have a most significant octet between 224 and 239, and is defined by RFC 5771

1.7.0fn is_broadcast(&self) -> bool

Returns true if this is a broadcast address.

A broadcast address has all octets set to 255 as defined in RFC 919.

1.7.0fn is_documentation(&self) -> bool

Returns true if this address is in a range designated for documentation.

This is defined in RFC 5737:

  • 192.0.2.0/24 (TEST-NET-1)
  • 198.51.100.0/24 (TEST-NET-2)
  • 203.0.113.0/24 (TEST-NET-3)

fn to_ipv6_compatible(&self) -> Ipv6Addr

Converts this address to an IPv4-compatible IPv6 address.

a.b.c.d becomes ::a.b.c.d

fn to_ipv6_mapped(&self) -> Ipv6Addr

Converts this address to an IPv4-mapped IPv6 address.

a.b.c.d becomes ::ffff:a.b.c.d