Struct addr_hal::Ipv4Addr

pub struct Ipv4Addr<IV4: Ipv4Address> { /* fields omitted */ }

An IPv4 address.

IPv4 addresses are defined as 32-bit integers in IETF RFC 791. They are usually represented as four octets.

See IpAddr for a type encompassing both IPv4 and IPv6 addresses.

The size of an Ipv4Addr struct may vary depending on the target operating system.

Textual representation

Ipv4Addr provides a FromStr implementation. The four octets are in decimal notation, divided by . (this is called "dot-decimal notation").

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

let localhost = Ipv4Addr::<Ipv4AddrInner>::new(127, 0, 0, 1);
assert_eq!("127.0.0.1".parse(), Ok(localhost));
//assert_eq!(localhost.is_loopback(), true);

Methods

impl<IV4: Ipv4Address> Ipv4Addr<IV4>

pub const LOCALHOST: Self

An IPv4 address with the address pointing to localhost: 127.0.0.1.

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

let addr: Ipv4Addr<Ipv4AddrInner> = Ipv4Addr::LOCALHOST;
assert_eq!(addr, Ipv4Addr::new(127, 0, 0, 1));

pub const UNSPECIFIED: Self

An IPv4 address representing an unspecified address: 0.0.0.0

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

let addr: Ipv4Addr<Ipv4AddrInner> = Ipv4Addr::UNSPECIFIED;
assert_eq!(addr, Ipv4Addr::new(0, 0, 0, 0));

pub const BROADCAST: Self

An IPv4 address representing the broadcast address: 255.255.255.255

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

let addr: Ipv4Addr<Ipv4AddrInner> = Ipv4Addr::BROADCAST;
assert_eq!(addr, Ipv4Addr::new(255, 255, 255, 255));

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

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

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

let addr: Ipv4Addr<Ipv4AddrInner> = Ipv4Addr::new(127, 0, 0, 1);

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

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

let addr: Ipv4Addr<Ipv4AddrInner> = Ipv4Addr::new(127, 0, 0, 1);
assert_eq!(addr.octets(), [127, 0, 0, 1]);

pub fn is_benchmarking(&self) -> bool

Returns true if this address part of the 198.18.0.0/15 range, which is reserved for network devices benchmarking. This range is defined in IETF RFC 2544 as 192.18.0.0 through 198.19.255.255 but errata 423 corrects it to 198.18.0.0/15.

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(198, 17, 255, 255).is_benchmarking(), false);
assert_eq!(Ipv4::new(198, 18, 0, 0).is_benchmarking(), true);
assert_eq!(Ipv4::new(198, 19, 255, 255).is_benchmarking(), true);
assert_eq!(Ipv4::new(198, 20, 0, 0).is_benchmarking(), false);

pub fn is_broadcast(&self) -> bool

Returns true if this is a broadcast address (255.255.255.255).

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(255, 255, 255, 255).is_broadcast(), true);
assert_eq!(Ipv4::new(236, 168, 10, 65).is_broadcast(), false);

pub fn is_documentation(&self) -> bool

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

This is defined in IETF 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)

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(192, 0, 2, 255).is_documentation(), true);
assert_eq!(Ipv4::new(198, 51, 100, 65).is_documentation(), true);
assert_eq!(Ipv4::new(203, 0, 113, 6).is_documentation(), true);
assert_eq!(Ipv4::new(193, 34, 17, 19).is_documentation(), false);

pub fn is_global(&self) -> bool

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

The following return false:

• private addresses (see is_private())
• the loopback address (see is_loopback())
• the link-local address (see is_link_local())
• the broadcast address (see is_broadcast())
• addresses used for documentation (see is_documentation())
• the unspecified address (see is_unspecified()), and the whole 0.0.0.0/8 block
• addresses reserved for future protocols (see is_ietf_protocol_assignment(), except 192.0.0.9/32 and 192.0.0.10/32 which are globally routable
• addresses reserved for future use (see is_reserved()
• addresses reserved for networking devices benchmarking (see is_benchmarking)

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

// private addresses are not global
assert_eq!(Ipv4::new(10, 254, 0, 0).is_global(), false);
assert_eq!(Ipv4::new(192, 168, 10, 65).is_global(), false);
assert_eq!(Ipv4::new(172, 16, 10, 65).is_global(), false);

// the 0.0.0.0/8 block is not global
assert_eq!(Ipv4::new(0, 1, 2, 3).is_global(), false);
// in particular, the unspecified address is not global
assert_eq!(Ipv4::new(0, 0, 0, 0).is_global(), false);

// the loopback address is not global
assert_eq!(Ipv4::new(127, 0, 0, 1).is_global(), false);

// link local addresses are not global
assert_eq!(Ipv4::new(169, 254, 45, 1).is_global(), false);

// the broadcast address is not global
assert_eq!(Ipv4::new(255, 255, 255, 255).is_global(), false);

// the address space designated for documentation is not global
assert_eq!(Ipv4::new(192, 0, 2, 255).is_global(), false);
assert_eq!(Ipv4::new(198, 51, 100, 65).is_global(), false);
assert_eq!(Ipv4::new(203, 0, 113, 6).is_global(), false);

// shared addresses are not global
assert_eq!(Ipv4::new(100, 100, 0, 0).is_global(), false);

// addresses reserved for protocol assignment are not global
assert_eq!(Ipv4::new(192, 0, 0, 0).is_global(), false);
assert_eq!(Ipv4::new(192, 0, 0, 255).is_global(), false);

// addresses reserved for future use are not global
assert_eq!(Ipv4::new(250, 10, 20, 30).is_global(), false);

// addresses reserved for network devices benchmarking are not global
assert_eq!(Ipv4::new(198, 18, 0, 0).is_global(), false);

// All the other addresses are global
assert_eq!(Ipv4::new(1, 1, 1, 1).is_global(), true);
assert_eq!(Ipv4::new(80, 9, 12, 3).is_global(), true);

pub fn is_ietf_protocol_assignment(&self) -> bool

Returns true if this address is part of 192.0.0.0/24, which is reserved to IANA for IETF protocol assignments, as documented in IETF RFC 6890.

Note that parts of this block are in use:

• 192.0.0.8/32 is the "IPv4 dummy address" (see IETF RFC 7600)
• 192.0.0.9/32 is the "Port Control Protocol Anycast" (see IETF RFC 7723)
• 192.0.0.10/32 is used for NAT traversal (see IETF RFC 8155)

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(192, 0, 0, 0).is_ietf_protocol_assignment(), true);
assert_eq!(Ipv4::new(192, 0, 0, 8).is_ietf_protocol_assignment(), true);
assert_eq!(Ipv4::new(192, 0, 0, 9).is_ietf_protocol_assignment(), true);
assert_eq!(Ipv4::new(192, 0, 0, 255).is_ietf_protocol_assignment(), true);
assert_eq!(Ipv4::new(192, 0, 1, 0).is_ietf_protocol_assignment(), false);
assert_eq!(Ipv4::new(191, 255, 255, 255).is_ietf_protocol_assignment(), false);

pub fn is_link_local(&self) -> bool

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

This property is defined by IETF RFC 3927.

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(169, 254, 0, 0).is_link_local(), true);
assert_eq!(Ipv4::new(169, 254, 10, 65).is_link_local(), true);
assert_eq!(Ipv4::new(16, 89, 10, 65).is_link_local(), false);

pub fn is_loopback(&self) -> bool

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

This property is defined by IETF RFC 1122.

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(127, 0, 0, 1).is_loopback(), true);
assert_eq!(Ipv4::new(45, 22, 13, 197).is_loopback(), false);

pub fn is_multicast(&self) -> bool

Returns true if this is a multicast address (224.0.0.0/4).

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(224, 254, 0, 0).is_multicast(), true);
assert_eq!(Ipv4::new(236, 168, 10, 65).is_multicast(), true);
assert_eq!(Ipv4::new(172, 16, 10, 65).is_multicast(), false);

pub fn is_private(&self) -> bool

Returns true if this is a private address.

The private address ranges are defined in IETF RFC 1918 and include:

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(10, 0, 0, 1).is_private(), true);
assert_eq!(Ipv4::new(10, 10, 10, 10).is_private(), true);
assert_eq!(Ipv4::new(172, 16, 10, 10).is_private(), true);
assert_eq!(Ipv4::new(172, 29, 45, 14).is_private(), true);
assert_eq!(Ipv4::new(172, 32, 0, 2).is_private(), false);
assert_eq!(Ipv4::new(192, 168, 0, 2).is_private(), true);
assert_eq!(Ipv4::new(192, 169, 0, 2).is_private(), false);

pub fn is_reserved(&self) -> bool

Returns true if this address is reserved by IANA for future use. IETF RFC 1112 defines the block of reserved addresses as 240.0.0.0/4. This range normally includes the broadcast address 255.255.255.255, but this implementation explicitely excludes it, since it is obviously not reserved for future use.

Warning

As IANA assigns new addresses, this method will be updated. This may result in non-reserved addresses being treated as reserved in code that relies on an outdated version of this method.

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(240, 0, 0, 0).is_reserved(), true);
assert_eq!(Ipv4::new(255, 255, 255, 254).is_reserved(), true);

assert_eq!(Ipv4::new(239, 255, 255, 255).is_reserved(), false);
// The broadcast address is not considered as reserved for future use by this implementation
assert_eq!(Ipv4::new(255, 255, 255, 255).is_reserved(), false);

pub fn is_shared(&self) -> bool

Returns true if this address is part of the Shared Address Space defined in IETF RFC 6598 (100.64.0.0/10).

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(100, 64, 0, 0).is_shared(), true);
assert_eq!(Ipv4::new(100, 127, 255, 255).is_shared(), true);
assert_eq!(Ipv4::new(100, 128, 0, 0).is_shared(), false);

pub fn is_unspecified(&self) -> bool

Returns true for the special 'unspecified' address (0.0.0.0).

This property is defined in UNIX Network Programming, Second Edition, W. Richard Stevens, p. 891; see also ip7.

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;

assert_eq!(Ipv4::new(0, 0, 0, 0).is_unspecified(), true);
assert_eq!(Ipv4::new(45, 22, 13, 197).is_unspecified(), false);

pub fn to_ipv6_compatible<IV6: Ipv6Address>(&self) -> Ipv6Addr<IV6>

Converts this address to an IPv4-compatible IPv6 address.

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

use addr_hal::Ipv6Addr;
use addr_mock::Ipv6AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;
type Ipv6 = Ipv6Addr<Ipv6AddrInner>;

assert_eq!(
    Ipv4::new(192, 0, 2, 255).to_ipv6_compatible(),
    Ipv6::new(0, 0, 0, 0, 0, 0, 49152, 767)
);

pub fn to_ipv6_mapped<IV6: Ipv6Address>(&self) -> Ipv6Addr<IV6>

Converts this address to an IPv4-mapped IPv6 address.

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

Examples

use addr_hal::Ipv4Addr;
use addr_mock::Ipv4AddrInner;

use addr_hal::Ipv6Addr;
use addr_mock::Ipv6AddrInner;

type Ipv4 = Ipv4Addr<Ipv4AddrInner>;
type Ipv6 = Ipv6Addr<Ipv6AddrInner>;

assert_eq!(Ipv4::new(192, 0, 2, 255).to_ipv6_mapped(),
           Ipv6::new(0, 0, 0, 0, 0, 65535, 49152, 767));

Trait Implementations

impl<IV4: Ipv4Address> Clone for Ipv4Addr<IV4>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<IV4: Ipv4Address> Copy for Ipv4Addr<IV4>

impl<IV4: Ipv4Address> Debug for Ipv4Addr<IV4>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<IV4: Ipv4Address> Display for Ipv4Addr<IV4>

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<IV4: Ipv4Address> Eq for Ipv4Addr<IV4>

impl<IV4: Ipv4Address> From<[u8; 4]> for Ipv4Addr<IV4>

fn from(octets: [u8; 4]) -> Ipv4Addr<IV4>

Examples

use std::net::Ipv4Addr;

let addr = Ipv4Addr::from([13u8, 12u8, 11u8, 10u8]);
assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);

impl<IV4: Ipv4Address> From<Ipv4Addr<IV4>> for u32

fn from(ip: Ipv4Addr<IV4>) -> u32

Converts an Ipv4Addr into a host byte order u32.

Examples

use std::net::Ipv4Addr;

let addr = Ipv4Addr::new(13, 12, 11, 10);
assert_eq!(0x0d0c0b0au32, u32::from(addr));

impl<IV4: Ipv4Address, IV6: Ipv6Address> From<Ipv4Addr<IV4>> for IpAddr<IV4, IV6>

fn from(ipv4: Ipv4Addr<IV4>) -> IpAddr<IV4, IV6>

Performs the conversion.

impl<IV4: Ipv4Address> From<u32> for Ipv4Addr<IV4>

fn from(ip: u32) -> Ipv4Addr<IV4>

Converts a host byte order u32 into an Ipv4Addr.

Examples

use std::net::Ipv4Addr;

let addr = Ipv4Addr::from(0x0d0c0b0au32);
assert_eq!(Ipv4Addr::new(13, 12, 11, 10), addr);

impl<IV4: Ipv4Address> FromStr for Ipv4Addr<IV4>

type Err = AddrParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ipv4Addr<IV4>, AddrParseError>

Parses a string s to return a value of this type.

impl<IV4: Ipv4Address> Hash for Ipv4Addr<IV4>

fn hash<H: Hasher>(&self, s: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<IV4: Ipv4Address> Ord for Ipv4Addr<IV4>

fn cmp(&self, other: &Ipv4Addr<IV4>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<IV4: Ipv4Address, IV6: Ipv6Address> PartialEq<IpAddr<IV4, IV6>> for Ipv4Addr<IV4>

fn eq(&self, other: &IpAddr<IV4, IV6>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<IV4: Ipv4Address> PartialEq<Ipv4Addr<IV4>> for Ipv4Addr<IV4>

fn eq(&self, other: &Ipv4Addr<IV4>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<IV4: Ipv4Address, IV6: Ipv6Address> PartialEq<Ipv4Addr<IV4>> for IpAddr<IV4, IV6>

fn eq(&self, other: &Ipv4Addr<IV4>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<IV4: Ipv4Address, IV6: Ipv6Address> PartialOrd<IpAddr<IV4, IV6>> for Ipv4Addr<IV4>

fn partial_cmp(&self, other: &IpAddr<IV4, IV6>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<IV4: Ipv4Address> PartialOrd<Ipv4Addr<IV4>> for Ipv4Addr<IV4>

fn partial_cmp(&self, other: &Ipv4Addr<IV4>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<IV4: Ipv4Address, IV6: Ipv6Address> PartialOrd<Ipv4Addr<IV4>> for IpAddr<IV4, IV6>

fn partial_cmp(&self, other: &Ipv4Addr<IV4>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.