This is the netaddr Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:46:48 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
netaddrA library for manipulating IP addresses, subnets, ranges, and sets.
Yacin Nadji <yacin@defmacro.cc>
MIT
1.0.0
str (system).
uiop (system).
alexandria (system).
cl-ppcre (system).
computable-reals (system).
closer-mop (system).
split-sequence (system).
packages.lisp (file).
main.lisp (file).
syntax.lisp (file).
reserved.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
netaddr/netaddr.asdnetaddr/packages.lispnetaddr/main.lispnetaddr/syntax.lispnetaddr/reserved.lispnetaddr/main.lisppackages.lisp (file).
netaddr (system).
add (function).
add! (function).
addnew (function).
addnew! (function).
contains? (generic function).
contiguous? (generic function).
disjoint? (generic function).
first-ip (generic reader).
(setf first-ip) (writer method).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
int (generic reader).
ip-equal (generic function).
ip-equalp (generic function).
ip-set-difference (function).
ip-set-intersection (function).
ip-set-symmetric-difference (function).
ip-set-union (function).
ip= (function).
last-ip (generic reader).
(setf last-ip) (writer method).
make-ip-address (generic function).
make-ip-network (function).
make-ip-range (function).
make-ip-set (function).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
size (generic function).
str (generic reader).
sub (function).
sub! (function).
subset? (function).
superset? (function).
version (reader method).
version (reader method).
%addnew! (function).
%compare (generic function).
->ip-range (generic function).
compact! (function).
compare (function).
compress-ipv6-str (function).
expand-ipv6-addr-to-parts (function).
in-set? (function).
integer-from-n-bits (function).
intersect (generic function).
ip+ (class).
ip-address (class).
ip-int-to-str (function).
ip-int-to-str-v4 (function).
ip-int-to-str-v6 (function).
ip-like (class).
ip-network (class).
ip-pair (class).
ip-range (class).
ip-set (class).
ipv4-str-to-int (function).
ipv4-str? (function).
ipv6-parts-to-int (function).
ipv6-str-to-int (function).
ipv6-str? (function).
largest-run (function).
make-ip-like (function).
mask (reader method).
mask-ip! (function).
range->cidrs (function).
remove-leading-zeroes (function).
shallow-copy-object (function).
strict-subset? (function).
strict-superset? (function).
subtract (function).
netaddr/syntax.lispmain.lisp (file).
netaddr (system).
enable-ip-syntax (macro).
#i-reader (function).
%enable-ip-syntax (function).
netaddr/reserved.lispsyntax.lisp (file).
netaddr (system).
multicast? (function).
private? (function).
public? (function).
reserved? (function).
route-type (function).
*ipv4-6to4* (special variable).
*ipv4-link-local* (special variable).
*ipv4-loopback* (special variable).
*ipv4-multicast* (special variable).
*ipv4-not-globally-reachable* (special variable).
*ipv4-not-globally-reachable-exceptions* (special variable).
*ipv4-reserved* (special variable).
*ipv4-rfc-1918* (special variable).
*ipv6-link-local* (special variable).
*ipv6-lookback* (special variable).
*ipv6-multicast* (special variable).
*ipv6-not-globally-reachable* (special variable).
*ipv6-not-globally-reachable-exceptions* (special variable).
*ipv6-reserved* (special variable).
*ipv6-unique-local* (special variable).
*multicast* (special variable).
*non-routable* (special variable).
*non-routable-exceptions* (special variable).
*private* (special variable).
*reserved* (special variable).
Packages are listed by definition order.
netaddrcommon-lisp.
add (function).
add! (function).
addnew (function).
addnew! (function).
contains? (generic function).
contiguous? (generic function).
disjoint? (generic function).
enable-ip-syntax (macro).
first-ip (generic reader).
(setf first-ip) (generic writer).
int (generic reader).
ip-equal (generic function).
ip-equalp (generic function).
ip-set-difference (function).
ip-set-intersection (function).
ip-set-symmetric-difference (function).
ip-set-union (function).
ip= (function).
last-ip (generic reader).
(setf last-ip) (generic writer).
make-ip-address (generic function).
make-ip-network (function).
make-ip-range (function).
make-ip-set (function).
multicast? (function).
private? (function).
public? (function).
reserved? (function).
route-type (function).
size (generic function).
str (generic reader).
sub (function).
sub! (function).
subset? (function).
superset? (function).
version (generic reader).
#i-reader (function).
%addnew! (function).
%compare (generic function).
%enable-ip-syntax (function).
*ipv4-6to4* (special variable).
*ipv4-link-local* (special variable).
*ipv4-loopback* (special variable).
*ipv4-multicast* (special variable).
*ipv4-not-globally-reachable* (special variable).
*ipv4-not-globally-reachable-exceptions* (special variable).
*ipv4-reserved* (special variable).
*ipv4-rfc-1918* (special variable).
*ipv6-link-local* (special variable).
*ipv6-lookback* (special variable).
*ipv6-multicast* (special variable).
*ipv6-not-globally-reachable* (special variable).
*ipv6-not-globally-reachable-exceptions* (special variable).
*ipv6-reserved* (special variable).
*ipv6-unique-local* (special variable).
*multicast* (special variable).
*non-routable* (special variable).
*non-routable-exceptions* (special variable).
*private* (special variable).
*reserved* (special variable).
->ip-range (generic function).
compact! (function).
compare (function).
compress-ipv6-str (function).
expand-ipv6-addr-to-parts (function).
in-set? (function).
integer-from-n-bits (function).
intersect (generic function).
ip+ (class).
ip-address (class).
ip-int-to-str (function).
ip-int-to-str-v4 (function).
ip-int-to-str-v6 (function).
ip-like (class).
ip-network (class).
ip-pair (class).
ip-range (class).
ip-set (class).
ipv4-str-to-int (function).
ipv4-str? (function).
ipv6-parts-to-int (function).
ipv6-str-to-int (function).
ipv6-str? (function).
largest-run (function).
make-ip-like (function).
mask (generic reader).
mask-ip! (function).
range->cidrs (function).
remove-leading-zeroes (function).
shallow-copy-object (function).
strict-subset? (function).
strict-superset? (function).
subtract (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Enables short-hand character reader macro for creating IP-LIKEs using #I. Using #I with a single argument like #I("192.168.0.0/16") or #I("::-ffff::") returns a single IP-LIKE and with multiple arguments like #I("1.2.3.4" "10.20.30.0/24" "::dada:beef") returns a list of IP-LIKEs.
Creates a copy of SET with IP-LIKES prepended.
Prepend in place IP-LIKES to the IP-SET SET. Returns the modified IP-SET.
Creates a fresh IP-SET that contains the original contents of SET as well as the IP-LIKES that are not already a member or a subset of a member of SET. Returns the fresh IP-SET.
Push IP-LIKES to IP-SET SET if they are not already a member or a subset of a member of SET. Returns the modified IP-SET.
Returns a fresh IP-SET that is the set difference of (first IP-SETS) from (rest IP-SETS).
Returns a fresh IP-SET that is the set intersection of all IP-SETS.
Returns a fresh IP-SET that is the set symmetric difference of IP-SETS, i.e., the difference of the union and intersection of IP-SETS.
Returns a fresh IP-SET that is the set union of all IP-SETS.
Make an IP-NETWORK object from a string STR in CIDR notation, e.g., "10.20.30.40/24" or "ffff::/96".
Make an IP-RANGE object given two STRINGs or INTEGERs that represent valid IP addresses as expected by MAKE-IP-ADDRESS. LAST must be greater than or equal to FIRST.
Make an IP-SET object given a list of IP-LIKEs.
Returns T if IP is an IP designated for multicast, otherwise NIL.
Returns T if IP is a private IP address, otherwise NIL.
Returns T if IP is a public IP address, otherwise NIL.
Returns T if IP is a reserved IP address, otherwise NIL.
Returns one of (:PRIVATE :RESERVED :MULTICAST :PUBLIC :OTHER) based on RFC defined IP usage.
Like SUB! but return a fresh IP-SET without modifying the argument SET in place.
Remove IP-LIKES from IP-SET SET in place. IP-LIKES that are a member or superset of a member of SET are removed. IP-LIKES that are a subset of a member of SET are SUBTRACTed in place.
Returns T or an IP-LIKE if IP-LIKE-1 is a subset of IP-LIKE-2. This is synonymous with (CONTAINS? IP-LIKE-2 IP-LIKE-1). Otherwise, returns NIL.
Returns T or an IP-LIKE if IP-LIKE-1 is a superset of IP-LIKE-2. Otherwise, NIL.
Returns T or an IP-LIKE if IP+ contains IP-LIKE, NIL otherwise.
ip-address) (ip2 ip-address)) ¶ip-pair) (ip ip-address)) ¶ip-address) (pair ip-pair)) ¶Returns T if IP-LIKE-1 and IP-LIKE-2 are contiguous, NIL otherwise.
ip-address) (i2 ip-address)) ¶ip-pair) (i ip-address)) ¶ip-address) (p ip-pair)) ¶Return T if IP-LIKE-1 and IP-LIKE-2 are disjoint, i.e., they share no IP addresses in common.
ip-address) (i2 ip-address)) ¶ip-pair) (i ip-address)) ¶ip-address) (p ip-pair)) ¶Returns the first IP-ADDRESS of an IP-NETWORK or IP-RANGE.
Returns the integer representation of IP-ADDRESS.
ip-address)) ¶Integer representation of the IP-ADDRESS.
int.
Returns T if IP+1 and IP+2 represent the same underlying IP address(es), are the same version of IP, and are instances of the same class (one of IP-ADDRESS, IP-PAIR, or IP-SET), or otherwise NIL.
Returns T if IP+1 and IP+2 represent the same underlying IP address(es), and are the same version of IP, or otherwise NIL. IP-RANGEs or IP-NETWORKs that contain a single IP will be IP-EQUALP to the IP-ADDRESS. See Equality in the README for details.
ip-address) (pair ip-pair)) ¶ip-pair) (ip ip-address)) ¶Returns the last IP-ADDRESS of an IP-NETWORK or IP-RANGE.
Make an IP-ADDRESS object from a STRING or INTEGER representation.
Returns an INTEGER of the number of IP addresses contained in IP+.
Returns the string representation of IP-ADDRESS.
ip-network)) ¶automatically generated reader method
str.
ip-address)) ¶String representation of the IP-ADDRESS.
str.
ip-address) &key) ¶ip-network) &key) ¶ip-address) out) ¶ip-network) out) ¶Compact an IP-SET’s internal data structure to remove duplicates and IP-LIKEs that are subsets of other IP-LIKEs already contained within the internal SET.
Given a string for an IP-LIKE, infer the concrete type and return an object.
Returns T or an IP-LIKE if IP-LIKE-1 is a subset and not IP-EQUAL to IP-LIKE-2.
Returns T or an IP-LIKE if IP-LIKE-1 is a superset of and not IP-EQUAL to IP-LIKE-2. Otherwise, NIL.
Return a fresh list of IP-RANGEs that represents IP-LIKE-1 after removing all IPs in IP-LIKE-2. If IP-LIKE-1 and IP-LIKE-2 are disjoint, a list containing the original IP-LIKE-1 is returned.
ip-address) (ip2 ip-address)) ¶ip-address) (p ip-pair)) ¶ip-pair) (ip ip-address)) ¶ip-address) (ip2 ip-address)) ¶ip-address) (p ip-pair)) ¶ip-pair) (ip ip-address)) ¶ip-network)) ¶automatically generated reader method
| Jump to: | #
%
(
-
A C D E F G I L M P R S V |
|---|
| Jump to: | #
%
(
-
A C D E F G I L M P R S V |
|---|
| Jump to: | *
F I L M S V |
|---|
| Jump to: | *
F I L M S V |
|---|
| Jump to: | C F I M N P R S |
|---|
| Jump to: | C F I M N P R S |
|---|