Skip aliased networks by default

Author: oschwald

example_test.go

@@ -67,7 +67,7 @@ func ExampleReader_Networks() {
 		Domain string `maxminddb:"connection_type"`
 	}{}
 
-	networks := db.Networks(maxminddb.SkipAliasedNetworks)
+	networks := db.Networks()
 	for networks.Next() {
 		subnet, err := networks.Network(&record)
 		if err != nil {
@@ -123,7 +123,7 @@ func ExampleReader_NetworksWithin() {
 		log.Panic(err)
 	}
 
-	networks := db.NetworksWithin(prefix, maxminddb.SkipAliasedNetworks)
+	networks := db.NetworksWithin(prefix)
 	for networks.Next() {
 		subnet, err := networks.Network(&record)
 		if err != nil {

traverse.go

@@ -14,11 +14,11 @@ type netNode struct {
 
 // Networks represents a set of subnets that we are iterating over.
 type Networks struct {
-	err                 error
-	reader              *Reader
-	nodes               []netNode
-	lastNode            netNode
-	skipAliasedNetworks bool
+	err                    error
+	reader                 *Reader
+	nodes                  []netNode
+	lastNode               netNode
+	includeAliasedNetworks bool
 }
 
 var (
@@ -29,23 +29,20 @@ var (
 // NetworksOption are options for Networks and NetworksWithin.
 type NetworksOption func(*Networks)
 
-// SkipAliasedNetworks is an option for Networks and NetworksWithin that
-// makes them not iterate over aliases of the IPv4 subtree in an IPv6
+// IncludeAliasedNetworks is an option for Networks and NetworksWithin
+// that makes them iterate over aliases of the IPv4 subtree in an IPv6
 // database, e.g., ::ffff:0:0/96, 2001::/32, and 2002::/16.
-//
-// You most likely want to set this. The only reason it isn't the default
-// behavior is to provide backwards compatibility to existing users.
-func SkipAliasedNetworks(networks *Networks) {
-	networks.skipAliasedNetworks = true
+func IncludeAliasedNetworks(networks *Networks) {
+	networks.includeAliasedNetworks = true
 }
 
 // Networks returns an iterator that can be used to traverse all networks in
 // the database.
 //
 // Please note that a MaxMind DB may map IPv4 networks into several locations
-// in an IPv6 database. This iterator will iterate over all of these locations
-// separately. To only iterate over the IPv4 networks once, use the
-// SkipAliasedNetworks option.
+// in an IPv6 database. This iterator will only iterate over these once by
+// default. To iterate over all the IPv4 network locations, use the
+// IncludeAliasedNetworks option.
 func (r *Reader) Networks(options ...NetworksOption) *Networks {
 	var networks *Networks
 	if r.Metadata.IPVersion == 6 {
@@ -122,7 +119,7 @@ func (n *Networks) Next() bool {
 		for node.pointer != n.reader.Metadata.NodeCount {
 			// This skips IPv4 aliases without hardcoding the networks that the writer
 			// currently aliases.
-			if n.skipAliasedNetworks && n.reader.ipv4Start != 0 &&
+			if !n.includeAliasedNetworks && n.reader.ipv4Start != 0 &&
 				node.pointer == n.reader.ipv4Start && !isInIPv4Subtree(node.ip) {
 				break
 			}

traverse_test.go

@@ -140,7 +140,6 @@ var tests = []networkTest{
 		Expected: []string{
 			"::1:ffff:ffff/128",
 		},
-		Options: []NetworksOption{SkipAliasedNetworks},
 	},
 	{
 		Network:  "::/0",
@@ -152,7 +151,6 @@ var tests = []networkTest{
 			"::2:0:50/125",
 			"::2:0:58/127",
 		},
-		Options: []NetworksOption{SkipAliasedNetworks},
 	},
 	{
 		Network:  "::2:0:40/123",
@@ -162,7 +160,6 @@ var tests = []networkTest{
 			"::2:0:50/125",
 			"::2:0:58/127",
 		},
-		Options: []NetworksOption{SkipAliasedNetworks},
 	},
 	{
 		Network:  "0:0:0:0:0:ffff:ffff:ff00/120",
@@ -192,7 +189,6 @@ var tests = []networkTest{
 			"1.1.1.16/28",
 			"1.1.1.32/32",
 		},
-		Options: []NetworksOption{SkipAliasedNetworks},
 	},
 	{
 		Network:  "::/0",
@@ -228,6 +224,7 @@ var tests = []networkTest{
 			"2002:101:110::/44",
 			"2002:101:120::/48",
 		},
+		Options: []NetworksOption{IncludeAliasedNetworks},
 	},
 	{
 		Network:  "::/0",
@@ -245,7 +242,6 @@ var tests = []networkTest{
 			"::2:0:50/125",
 			"::2:0:58/127",
 		},
-		Options: []NetworksOption{SkipAliasedNetworks},
 	},
 	{
 		Network:  "1.1.1.16/28",