iplist

Documentation

Overview

Package iplist handles the P2P Plaintext Format described by https://en.wikipedia.org/wiki/PeerGuardian#P2P_plaintext_format.

Index

• type IPList
  • func New(initSorted []Range) *IPList
  • func NewFromReader(f io.Reader) (ret *IPList, err error)
  • func (me *IPList) Lookup(ip net.IP) (r Range, ok bool)
  • func (me *IPList) NumRanges() int
  • func (me *IPList) WritePacked(w io.Writer) (err error)
• type PackedIPList
  • func NewFromPacked(b []byte) PackedIPList
  • func (me PackedIPList) Lookup(ip net.IP) (r Range, ok bool)
  • func (me PackedIPList) NumRanges() int
• type Range
  • func ParseBlocklistP2PLine(l []byte) (r Range, ok bool, err error)
  • func (r *Range) String() string
• type Ranger

Types

type IPList

type IPList struct {
	// contains filtered or unexported fields
}

func New

func New(initSorted []Range) *IPList

Create a new IP list. The given ranges must already sorted by the lower bound IP in each range. Behaviour is undefined for lists of overlapping ranges.

func NewFromReader

func NewFromReader(f io.Reader) (ret *IPList, err error)

Creates an IPList from a line-delimited P2P Plaintext file.

func (*IPList) Lookup

func (me *IPList) Lookup(ip net.IP) (r Range, ok bool)

Return the range the given IP is in. Returns nil if no range is found.

func (*IPList) NumRanges

func (me *IPList) NumRanges() int

func (*IPList) WritePacked

func (me *IPList) WritePacked(w io.Writer) (err error)

type PackedIPList

type PackedIPList []byte

func NewFromPacked

func NewFromPacked(b []byte) PackedIPList

func (PackedIPList) Lookup

func (me PackedIPList) Lookup(ip net.IP) (r Range, ok bool)

func (PackedIPList) NumRanges

func (me PackedIPList) NumRanges() int

type Range

type Range struct {
	First, Last net.IP
	Description string
}

func ParseBlocklistP2PLine

func ParseBlocklistP2PLine(l []byte) (r Range, ok bool, err error)

Parse a line of the PeerGuardian Text Lists (P2P) Format. Returns !ok but no error if a line doesn't contain a range but isn't erroneous, such as comment and blank lines.

func (*Range) String

func (r *Range) String() string

type Ranger

type Ranger interface {
	// Return a Range containing the IP.
	Lookup(net.IP) (r Range, ok bool)
	// If your ranges hurt, use this.
	NumRanges() int
}

An abstraction of IP list implementations.