p2p/netutil: update comments

This commit is contained in:
Felix Lange 2024-05-31 13:51:53 +02:00
parent b038ec08d9
commit 625ace53bb
2 changed files with 5 additions and 4 deletions

View file

@ -23,7 +23,8 @@ import (
"net/netip" "net/netip"
) )
// AddrAddr gets the IP address contained in addr. It returns nil if no address is present. // AddrAddr gets the IP address contained in addr. The result will be invalid if the
// address type is unsupported.
func AddrAddr(addr net.Addr) netip.Addr { func AddrAddr(addr net.Addr) netip.Addr {
switch a := addr.(type) { switch a := addr.(type) {
case *net.IPAddr: case *net.IPAddr:

View file

@ -143,7 +143,7 @@ func IsLAN(ip net.IP) bool {
return AddrIsLAN(IPToAddr(ip)) return AddrIsLAN(IPToAddr(ip))
} }
// IsLAN reports whether an IP is a local network address. // AddrIsLAN reports whether an IP is a local network address.
func AddrIsLAN(ip netip.Addr) bool { func AddrIsLAN(ip netip.Addr) bool {
if ip.Is4In6() { if ip.Is4In6() {
ip = netip.AddrFrom4(ip.As4()) ip = netip.AddrFrom4(ip.As4())
@ -276,7 +276,7 @@ func (s *DistinctNetSet) Remove(ip net.IP) {
s.RemoveAddr(IPToAddr(ip)) s.RemoveAddr(IPToAddr(ip))
} }
// Remove removes an IP from the set. // RemoveAddr removes an IP from the set.
func (s *DistinctNetSet) RemoveAddr(ip netip.Addr) { func (s *DistinctNetSet) RemoveAddr(ip netip.Addr) {
key := s.key(ip) key := s.key(ip)
if n, ok := s.members[key]; ok { if n, ok := s.members[key]; ok {
@ -293,7 +293,7 @@ func (s DistinctNetSet) Contains(ip net.IP) bool {
return s.ContainsAddr(IPToAddr(ip)) return s.ContainsAddr(IPToAddr(ip))
} }
// Contains whether the given IP is contained in the set. // ContainsAddr whether the given IP is contained in the set.
func (s DistinctNetSet) ContainsAddr(ip netip.Addr) bool { func (s DistinctNetSet) ContainsAddr(ip netip.Addr) bool {
key := s.key(ip) key := s.key(ip)
_, ok := s.members[key] _, ok := s.members[key]