README
¶
go-inet
A Go library for reading, formatting, sorting and converting IP-addresses and IP-blocks.
go-inet/inet
Package inet represents IP-addresses and IP-Blocks as comparable types.
The IP addresses and blocks from this package can be used as keys in maps, freely copied and fast sorted without prior conversion from/to IPv4/IPv6.
Some missing utility functions in the standard library for IP-addresses and IP-blocks are provided.
Blocks are IP-networks or IP-ranges, e.g.
192.168.0.1/24 // CIDR
::1/128 // CIDR
10.0.0.3-10.0.17.134 // IP range, no CIDR
2001:db8::1-2001:db8::f6 // IP range, no CIDR
go-inet/tree
Tree is an implementation of a CIDR or Block tree for fast IP lookup with longest-prefix-match. It is NOT a standard patricia-trie, this isn't possible for general blocks not represented as CIDRs.
The tree can be visualized as:
▼
├─ 10.0.0.0/9
│ ├─ 10.0.0.0/11
│ │ ├─ 10.0.0.0-10.0.0.29
│ │ ├─ 10.0.16.0/20
│ │ └─ 10.0.32.0/20
│ └─ 10.32.0.0/11
│ ├─ 10.32.8.0/22
│ ├─ 10.32.12.0-10.32.13.77
│ └─ 10.32.16.0/22
├─ 2001:db8:900::/48
│ ├─ 2001:db8:900::/49
│ │ ├─ 2001:db8:900::/52
Documentation
Full go doc style documentation for the project can be viewed online without
installing this package by using the excellent GoDoc site
Please study the applications in the examples directory to get familiar with the API.
Installation
$ go get -u github.com/gaissmai/go-inet/...
You can also view the documentation locally once the package is installed with
the godoc tool by running
$ godoc -http=:6060
and pointing your browser to http://localhost:6060/pkg/github.com/gaissmai/go-inet
License
go-inet is licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
module
|
|
|
cidrsplit
command
Command cidrsplit, split CIDR into smaller CIDRs Usage: cidrsplit [-t] start bits [bits]
|
Command cidrsplit, split CIDR into smaller CIDRs Usage: cidrsplit [-t] start bits [bits] |
|
inetinfo
command
Command inetinfo, print information about IP addresses, CIDRs and ranges.
|
Command inetinfo, print information about IP addresses, CIDRs and ranges. |
|
Package inet represents IP-addresses and IP-Blocks as comparable types.
|
Package inet represents IP-addresses and IP-Blocks as comparable types. |
|
Package internal for generating random ip addresses and CIDRs for benchmarking.
|
Package internal for generating random ip addresses and CIDRs for benchmarking. |
|
Package tree is an implementation of a CIDR/Block prefix tree for fast IP lookup with longest-prefix-match.
|
Package tree is an implementation of a CIDR/Block prefix tree for fast IP lookup with longest-prefix-match. |