Crate ipnet

Types for IPv4 and IPv6 network addresses.

This module provides types and methods for working with IPv4 and IPv6 network addresses, commonly called IP prefixes. Its design aligns to and makes use of the existing IpAddr, Ipv4Addr, and Ipv6Addr types provided in the Rust standard library.

The module also provides traits that extend Ipv4Addr and Ipv6Addr to support Add, Sub, BitAnd, and BitOr operations.

Organization

• IpNet represents IP network addresses of either IPv4 or IPv6.
• Ipv4Net and Ipv6Net are respectively IPv4 and IPv6 network addresses.
• IpAddrIter provides iteration over a range of IP addresses. IpNetIter does the same for IP network addresses. These are returned by methods on IpNet, Ipv4Net, and Ipv6Net.
• The IpAdd, IpSub, IpBitAnd, IpBitOr traits extend the Ipv4Addr and Ipv6Addr types to include these operations.
• Emu128 is an emulated 128 bit unsigned integer implemented in this module using a struct of two u64 types. This is necessary because Rust's u128 type is not yet marked stable. This can be replaced when u128 is stable.

Structs

AddrParseError	An error which can be returned when parsing an IP network address.
Emu128	An emulated 128 bit unsigned integer.
IpAddrIter	An Iterator over a range of IPv4 or IPv6 addresses.
IpNetIter	An Iterator over a range of IP network addresses.
Ipv4Net	An IPv4 network address.
Ipv6Net	An IPv6 network address.
PrefixLenError	An error that is returned when the prefix length is invalid. Valid prefix lengths are 0 to 32 for Ipv4 and 0 to 128 for IPv6.

Enums

IpNet

An IP network address, either IPv4 or IPv6.

Traits

Contains	Provides a contains() method to test if a network contains another network or address.
IpAdd	Provides a saturating_add() method for Ipv4Addr and Ipv6Addr.
IpBitAnd	Provides a bitand() method for Ipv4Addr and Ipv6Addr.
IpBitOr	Provides a bitor() method for Ipv4Addr and Ipv6Addr.
IpSub	Provides a saturating_sub() method for Ipv4Addr and Ipv6Addr.