From d07f8de10512f9fd4ddd8a602a4889532cd92bf0 Mon Sep 17 00:00:00 2001 From: "kayos@tcp.direct" Date: Fri, 8 Jul 2022 03:51:12 -0700 Subject: [PATCH] Docs: improve range iteration documentation --- network/range.go | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/network/range.go b/network/range.go index 242972d..7a0daf5 100644 --- a/network/range.go +++ b/network/range.go @@ -2,10 +2,14 @@ package network import ipa "inet.af/netaddr" -// IterateNetRange will ingest either a netaddr range or a netaddr prefix from the inet.af/netaddr package; -// returning a channel that will stream all the individual netaddr IPs within the given range or prefix. -// Alternatively, feed it a string in prefix or range format. (192.168.69.0/24) (192.168.69.0-192.168.69.254) -// Will return nil value if input is invalid. +/*IterateNetRange will ingest: + - an inet.af/netaddr.Range + - an inet.af/netaddr.Prefix + - or a string to be parsed as either of the above options + - examples: (192.168.69.0/24) (192.168.69.0-192.168.69.254) + + then it returns a channel that will stream all the individual netaddr.IP types within the given range or prefix. + if the input is invalid this function will return nil.*/ func IterateNetRange(ips interface{}) chan ipa.IP { var addrs ipa.IPRange