ipnet

Documentation

Index

• Constants
• Variables
• func Contains(start, end, ip net.IP) bool
• func IPLess(a, b net.IP) bool
• func IPToUint32(ip net.IP) uint32
• func IPv4StrToUint32(ipStr string) uint32
• func IPv4ToUint32(ip net.IP) uint32
• func IsFirstIP(ip net.IP, ipv6 bool) bool
• func IsLastIP(ip net.IP, ipv6 bool) bool
• func LastIP(ipNet *net.IPNet) net.IP
• func MaskLess(a, b *net.IPNet) bool
• func NextIP(ip net.IP) net.IP
• func PrefixSameLength(start, end net.IP) int
• func PrevIP(ip net.IP) net.IP
• func SuffixZeroLength(ip net.IP) int
• func Uint32ToIPv4(uip uint32) net.IP
• func Uint64ToIP(uip uint64) net.IP
• func Uint64ToIP2(high, low uint64) net.IP
• type Range
  • func NewRange(ipNet *net.IPNet) *Range
  • func (r *Range) CommonRange(ip net.IP, r2 *Range) bool
  • func (r *Range) Contains(ip net.IP) bool
  • func (r *Range) IPNets() []*net.IPNet
  • func (r *Range) Join(r2 *Range) bool
  • func (r *Range) JoinIPNet(ipNet *net.IPNet) bool
• type Ranges
  • func (r Ranges) Len() int
  • func (r Ranges) Less(i, j int) bool
  • func (r Ranges) Swap(i, j int)

Constants

const MaxIPv4Uint32 = 4294967295

MaxIPv4Uint32 largest possible uint32 value for an IPv4 address

Variables

var (
	FirstIPv4 = net.IPv4(0, 0, 0, 0)
	LastIPv4  = net.IPv4(255, 255, 255, 255)
	FirstIPv6 = make(net.IP, net.IPv6len)
	LastIPv6  = net.IP{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
)

Functions

func Contains

func Contains(start, end, ip net.IP) bool

Contains checks if the given IP is within the range of start to end (inclusive of start and exclusive of end).

func IPLess

func IPLess(a, b net.IP) bool

IPLess compares two IPs and returns true if the first IP is less than the second. IPv4 < IPv6

func IPToUint32

func IPToUint32(ip net.IP) uint32

IPToUint32 IP 转换为 uint32, IPv6 返回前 32 位

func IPv4StrToUint32

func IPv4StrToUint32(ipStr string) uint32

IPv4StrToUint32 IPv4字符串 转换为 uint32 (syntactic sugar)

func IPv4ToUint32

func IPv4ToUint32(ip net.IP) uint32

IPv4ToUint32 IPv4 转换为 uint32

func IsFirstIP

func IsFirstIP(ip net.IP, ipv6 bool) bool

IsFirstIP checks if the given IP is the first IP of its kind (IPv4 or IPv6).

func IsLastIP

func IsLastIP(ip net.IP, ipv6 bool) bool

IsLastIP checks if the given IP is the last IP of its kind (IPv4 or IPv6).

func LastIP

func LastIP(ipNet *net.IPNet) net.IP

LastIP returns the last IP address within the provided IPNet.

func MaskLess

func MaskLess(a, b *net.IPNet) bool

MaskLess compares two CIDRs. Returns true if the first CIDR has a larger prefix length (smaller network) than the second. IPv4 networks are considered smaller than IPv6.

func NextIP

func NextIP(ip net.IP) net.IP

NextIP returns the IP immediately after the given IP.

func PrefixSameLength

func PrefixSameLength(start, end net.IP) int

PrefixSameLength determines the length of the common prefix between two IPs.

func PrevIP

func PrevIP(ip net.IP) net.IP

PrevIP returns the IP immediately before the given IP.

func SuffixZeroLength

func SuffixZeroLength(ip net.IP) int

SuffixZeroLength calculates the length of trailing zeros in the IP.

func Uint32ToIPv4

func Uint32ToIPv4(uip uint32) net.IP

Uint32ToIPv4 uint32

func Uint64ToIP

func Uint64ToIP(uip uint64) net.IP

Uint64ToIP uint64 转换为 IP

func Uint64ToIP2

func Uint64ToIP2(high, low uint64) net.IP

Uint64ToIP2 uint64 转换为 IP

Types

type Range

type Range struct {
	Start net.IP
	End   net.IP
}

Range represents an IP range with a start and end IP.

func NewRange

func NewRange(ipNet *net.IPNet) *Range

NewRange initializes an IP range based on the provided IPNet. It normalizes the IP addresses to IPv6 length for consistency.

func (*Range) CommonRange

func (r *Range) CommonRange(ip net.IP, r2 *Range) bool

CommonRange finds the common IP range between the current range and another range (r2), ensuring that the resulting range contains the specified IP.

func (*Range) Contains

func (r *Range) Contains(ip net.IP) bool

Contains checks if the IP range contains a specific IP.

func (*Range) IPNets

func (r *Range) IPNets() []*net.IPNet

IPNets returns the CIDR groups corresponding to the IP range.

func (*Range) Join

func (r *Range) Join(r2 *Range) bool

Join attempts to merge the current IP range with another range (r2). It forbids merging if the start IP of r2 is before the current range or if the ranges aren't adjacent.

func (*Range) JoinIPNet

func (r *Range) JoinIPNet(ipNet *net.IPNet) bool

JoinIPNet tries to merge the current IP range with a provided IPNet. It forbids merging if the start IP of IPNet is before the current range or if they aren't adjacent.

type Ranges

type Ranges []Range

Ranges represents a slice of IP ranges.

func (Ranges) Len

func (r Ranges) Len() int

Len returns the number of IP ranges.

func (Ranges) Less

func (r Ranges) Less(i, j int) bool

Less checks if the start IP of the range at index i is less than that at index j.

func (Ranges) Swap

func (r Ranges) Swap(i, j int)

Swap swaps the positions of two IP ranges in the slice.