cidr

Documentation

Index

• Constants
• func Contains(ipNets []*net.IPNet, ipNet *net.IPNet) bool
• func ContainsAll(ipNets1, ipNets2 []*net.IPNet) bool
• func Equal(n, o *net.IPNet) bool
• func RemoveAll(ipNets, toRemove []*net.IPNet) []*net.IPNet
• func ZeroNet(family int) *net.IPNet
• type CIDR
  • func DiffCIDRLists(old, new []*CIDR) (add, remove []*CIDR)
  • func MustParseCIDR(str string) *CIDR
  • func NewCIDR(ipnet *net.IPNet) *CIDR
  • func ParseCIDR(str string) (*CIDR, error)
  • func (n *CIDR) AvailableIPs() int
  • func (n *CIDR) DeepCopy() *CIDR
  • func (in *CIDR) DeepCopyInto(out *CIDR)
  • func (in *CIDR) DeepEqual(other *CIDR) bool
  • func (n *CIDR) Equal(o *CIDR) bool

Constants

const (
	FAMILY_ALL  = nl.FAMILY_ALL
	FAMILY_V4   = nl.FAMILY_V4
	FAMILY_V6   = nl.FAMILY_V6
	FAMILY_MPLS = nl.FAMILY_MPLS
)

Family type definitions

Functions

func Contains

func Contains(ipNets []*net.IPNet, ipNet *net.IPNet) bool

Contains returns true if 'ipNets' contains ipNet.

func ContainsAll

func ContainsAll(ipNets1, ipNets2 []*net.IPNet) bool

ContainsAll returns true if 'ipNets1' contains all net.IPNet of 'ipNets2'

func Equal

func Equal(n, o *net.IPNet) bool

Equal returns true if the n and o net.IPNet CIDRs are Equal.

func RemoveAll

func RemoveAll(ipNets, toRemove []*net.IPNet) []*net.IPNet

RemoveAll removes all cidrs specified in 'toRemove' from 'ipNets'. ipNets is clobbered (to ensure removed CIDRs can be garbage collected) and must not be used after this function has been called. Example usage:

cidrs = cidr.RemoveAll(cidrs, toRemove)

func ZeroNet

func ZeroNet(family int) *net.IPNet

ZeroNet generates a zero net.IPNet object for the given address family

Types

type CIDR

type CIDR struct {
	*net.IPNet
}

CIDR is a network CIDR representation based on net.IPNet

func DiffCIDRLists

func DiffCIDRLists(old, new []*CIDR) (add, remove []*CIDR)

DiffCIDRLists compares an old and new list of CIDRs and returns the list of removed and added CIDRs

func MustParseCIDR

func MustParseCIDR(str string) *CIDR

MustParseCIDR parses the CIDR string using net.ParseCIDR and panics if the CIDR cannot be parsed

func NewCIDR

func NewCIDR(ipnet *net.IPNet) *CIDR

NewCIDR returns a new CIDR using a net.IPNet

func ParseCIDR

func ParseCIDR(str string) (*CIDR, error)

ParseCIDR parses the CIDR string using net.ParseCIDR

func (*CIDR) AvailableIPs

func (n *CIDR) AvailableIPs() int

AvailableIPs returns the number of IPs available in a CIDR

func (*CIDR) DeepCopy

func (n *CIDR) DeepCopy() *CIDR

DeepCopy creates a deep copy of a CIDR

func (*CIDR) DeepCopyInto

func (in *CIDR) DeepCopyInto(out *CIDR)

DeepCopyInto is a deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*CIDR) DeepEqual

func (in *CIDR) DeepEqual(other *CIDR) bool

DeepEqual is an deepequal function, deeply comparing the receiver with other. in must be non-nil.

func (*CIDR) Equal

func (n *CIDR) Equal(o *CIDR) bool

Equal returns true if the receiver's CIDR equals the other CIDR.