addressutil

Documentation

Overview

Package addressutil contains helpers working with addresses.

Index

• func CompareAddressStatuses(comparePrefixes func(a, b netip.Prefix) int) func(a, b *network.AddressStatus) int
• func CompareByAlgorithm(algorithm nethelpers.AddressSortAlgorithm) func(a, b netip.Prefix) int
• func ComparePrefixNew(a, b netip.Prefix) int
• func ComparePrefixesLegacy(a, b netip.Prefix) int
• func DeduplicateIPPrefixes(in []netip.Prefix) []netip.Prefix
• func FilterIPs(addrs []netip.Prefix, includeSubnets, excludeSubnets []netip.Prefix) []netip.Prefix

Functions

func CompareAddressStatuses

func CompareAddressStatuses(comparePrefixes func(a, b netip.Prefix) int) func(a, b *network.AddressStatus) int

CompareAddressStatuses compares two address statuses with the prefix comparison func.

The comparison of AddressStatuses sorts by link name and then by address.

func CompareByAlgorithm

func CompareByAlgorithm(algorithm nethelpers.AddressSortAlgorithm) func(a, b netip.Prefix) int

CompareByAlgorithm returns a comparison function based on the given algorithm.

func ComparePrefixNew

func ComparePrefixNew(a, b netip.Prefix) int

ComparePrefixNew compares two prefixes by address family, address, and prefix length.

It prefers more specific prefixes.

func ComparePrefixesLegacy

func ComparePrefixesLegacy(a, b netip.Prefix) int

ComparePrefixesLegacy is the old way to sort prefixes.

It only compares addresses and does not take prefix length into account.

func DeduplicateIPPrefixes

func DeduplicateIPPrefixes(in []netip.Prefix) []netip.Prefix

DeduplicateIPPrefixes removes duplicates from the given list of prefixes.

The input list must be sorted. DeduplicateIPPrefixes performs in-place deduplication.

func FilterIPs

func FilterIPs(addrs []netip.Prefix, includeSubnets, excludeSubnets []netip.Prefix) []netip.Prefix

FilterIPs filters the given list of IP prefixes based on the given include and exclude subnets.

If includeSubnets is not empty, only IPs that are in one of the subnets are included. If excludeSubnets is not empty, IPs that are in one of the subnets are excluded.