address

Documentation

Index

• type Address
  • func Add(addr Address, i Offset) Address
  • func FromIP4(ip4 net.IP) (r Address)
  • func ParseIP(s string) (Address, error)
  • func (addr Address) IP4() (r net.IP)
  • func (addr Address) MarshalJSON() ([]byte, error)
  • func (addr Address) Reverse() Address
  • func (addr Address) String() string
• type CIDR
  • func MakeCIDR(subnet CIDR, addr Address) CIDR
  • func NewCIDRs(ranges []Range) (cidrs []CIDR)
  • func ParseCIDR(s string) (CIDR, error)
  • func RemoveCommon(a, b []CIDR) (newA, newB []CIDR)
  • func (cidr CIDR) End() Address
  • func (cidr CIDR) HostRange() Range
  • func (cidr CIDR) IPNet() (r *net.IPNet)
  • func (cidr CIDR) IsSubnet() bool
  • func (cidr CIDR) Range() Range
  • func (cidr CIDR) Size() Offset
  • func (cidr CIDR) Start() Address
  • func (cidr CIDR) String() string
• type Count
  • func Length(a, b Address) Count
  • func Min(a, b Count) Count
• type Offset
  • func Subtract(a, b Address) Offset
• type Range
  • func Merge(r []Range) []Range
  • func NewRange(start Address, size Offset) Range
  • func (r Range) AsCIDRString() string
  • func (r Range) BiggestCIDRRange() Range
  • func (r Range) CIDRs() []CIDR
  • func (r Range) Contains(addr Address) bool
  • func (r Range) Overlaps(or Range) bool
  • func (r Range) Size() Count
  • func (r Range) String() string

Types

type Address

type Address uint32

Using 32-bit integer to represent IPv4 address

func Add

func Add(addr Address, i Offset) Address

func FromIP4

func FromIP4(ip4 net.IP) (r Address)

FromIP4 converts an ipv4 address to our integer address type

func ParseIP

func ParseIP(s string) (Address, error)

func (Address) IP4

func (addr Address) IP4() (r net.IP)

IP4 converts our integer address type to an ipv4 address

func (Address) MarshalJSON

func (addr Address) MarshalJSON() ([]byte, error)

func (Address) Reverse

func (addr Address) Reverse() Address

func (Address) String

func (addr Address) String() string

type CIDR

type CIDR struct {
	Addr      Address
	PrefixLen int
}

func MakeCIDR

func MakeCIDR(subnet CIDR, addr Address) CIDR

func NewCIDRs

func NewCIDRs(ranges []Range) (cidrs []CIDR)

func ParseCIDR

func ParseCIDR(s string) (CIDR, error)

func RemoveCommon

func RemoveCommon(a, b []CIDR) (newA, newB []CIDR)

RemoveCommon filters out CIDR ranges which are contained in both a and b slices. Both slices have to be sorted in increasing order.

func (CIDR) End

func (cidr CIDR) End() Address

cidr = [Start; End)

func (CIDR) HostRange

func (cidr CIDR) HostRange() Range

func (CIDR) IPNet

func (cidr CIDR) IPNet() (r *net.IPNet)

func (CIDR) IsSubnet

func (cidr CIDR) IsSubnet() bool

func (CIDR) Range

func (cidr CIDR) Range() Range

func (CIDR) Size

func (cidr CIDR) Size() Offset

func (CIDR) Start

func (cidr CIDR) Start() Address

func (CIDR) String

func (cidr CIDR) String() string

type Count

type Count uint32

func Length

func Length(a, b Address) Count

func Min

func Min(a, b Count) Count

type Offset

type Offset uint32

func Subtract

func Subtract(a, b Address) Offset

type Range

type Range struct {
	Start, End Address // [Start, End); Start <= End
}

func Merge

func Merge(r []Range) []Range

Merge merges adjacent range entries. The given slice has to be sorted in increasing order.

func NewRange

func NewRange(start Address, size Offset) Range

func (Range) AsCIDRString

func (r Range) AsCIDRString() string

func (Range) BiggestCIDRRange

func (r Range) BiggestCIDRRange() Range

func (Range) CIDRs

func (r Range) CIDRs() []CIDR

CIDRs returns a list of CIDR-aligned ranges which cover this range.

func (Range) Contains

func (r Range) Contains(addr Address) bool

func (Range) Overlaps

func (r Range) Overlaps(or Range) bool

func (Range) Size

func (r Range) Size() Count

func (Range) String

func (r Range) String() string