netlists

README

go-netlists

License

MPL 2.0.

Documentation

Overview

Package netlists implements helpers to work with IP address lists.

Index

• Variables
• type CIDR
  • func ParseCIDR(v string) (CIDR, error)
• type MemorySet
  • func (ms *MemorySet) Add(cidr string) error
  • func (ms *MemorySet) Has(cidr string) (ok bool, err error)
• type Set

Variables

var (
	ErrInvalidCIDR       = errors.New("invalid CIDR")
	ErrInvalidMaskLength = errors.New("invalid mask size bits")
)

Types

type CIDR

type CIDR interface {
	IsIP4() bool
	IsIP6() bool

	// MaskLength returns the mask size in bits.
	//
	// For IPv4, the returned value is `>=0 && <=32`.
	//
	// For IPv6, the returned value is `>=0 && <=128`.
	MaskLength() int

	// IPString returns only the IP component as a string.
	IPString() string

	String() string

	WithMaskLength(maskLength int) (CIDR, error)
	// contains filtered or unexported methods
}

func ParseCIDR

func ParseCIDR(v string) (CIDR, error)

type MemorySet

type MemorySet struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

MemorySet is an in-memory implementation of `Set`.

func (*MemorySet) Add

func (ms *MemorySet) Add(cidr string) error

func (*MemorySet) Has

func (ms *MemorySet) Has(cidr string) (ok bool, err error)

type Set

type Set interface {
	Add(cidr string) error

	Has(cidr string) (ok bool, err error)
}