Net.IP
module Net.IP
Validated, canonical IP addresses and CIDR networks.
using Net.IP
let address = Address.parse("192.0.2.42").try
let network = Network.parse("192.0.2.0/24").try
network.contains(address) # => truerecord Address
A canonical IPv4 or IPv6 address.
The stored spelling is normalized, so addresses that arrived in different forms compare and print consistently. Zone identifiers such as %en0 are properties of socket endpoints and do not belong here.
Fields
sourceString
Methods
string
string : StringReturns the canonical text form of the address.
Returns canonical address text
Examples
Normalizing an IPv6 address for a log or cache key
Address.parse("2001:0db8:0:0::42").try.string # => "2001:db8::42"version
version : IntegerReturns the address family as 4 or 6.
Returns 4 for IPv4 or 6 for IPv6
Examples
Selecting a family-specific socket policy
let family = address.version == 6 then :ipv6 else :ipv4loopback?
loopback? : BoolReturns true for an address that routes back to this host.
This covers the IPv4 127.0.0.0/8 block as well as IPv6 ::1; it is not limited to the familiar 127.0.0.1 spelling.
Returns whether this is a loopback address
Examples
Refusing to expose a development service beyond this machine
die("development server must use loopback") if !address.loopback?private?
private? : BoolReturns true for an address reserved for private networks.
Use this as one signal in a network policy, not as proof that a peer is trusted: private addresses can still belong to another machine.
Returns whether this is a private-use address
Examples
Rejecting a public target in an internal-only configuration
Error("target must be private") if !target.private?unspecified?
unspecified? : BoolReturns true for the all-zero address: 0.0.0.0 or ::.
On a listening endpoint this usually means "all local interfaces". It is not a usable remote destination.
Returns whether every address bit is zero
Examples
Warning before binding a service on every interface
IO.warn("service will be publicly reachable") if bind.unspecified?multicast?
multicast? : BoolReturns true when the address names a multicast group.
Returns whether this is a multicast address
Examples
Choosing multicast-specific socket setup
let mode = destination.multicast? then :group else :unicastrecord Network
A canonical CIDR network with host bits cleared.
Parsing 192.0.2.9/24 therefore produces 192.0.2.0/24. This makes a Network suitable for access-control rules and routing tables: its identity is the range, not whichever host address happened to describe it.
Fields
sourceString
Methods
string
string : StringReturns canonical CIDR text, including the prefix length.
Returns canonical CIDR text
Examples
Network.parse("192.0.2.99/24").try.string # => "192.0.2.0/24"contains
contains(address: Address) -> BoolReturns true when address falls within this network.
An address from the other family is simply outside the network; callers do not need to compare version first.
Parameters
address- the address to test
Returns whether address belongs to this network
Examples
Checking an application allowlist
let office = Network.parse("198.51.100.0/24").try
let allowed? = office.contains(requestAddress)prefix
prefix : IntegerReturns the number of fixed leading address bits.
Returns the prefix length
Examples
Network.parse("10.0.0.0/8").try.prefix # => 8first
first : AddressReturns the first address in the range: the address with all host bits cleared.
Returns the first address in the range
Examples
Network.parse("192.0.2.9/24").try.first.string # => "192.0.2.0"last
last : AddressReturns the last address in the range: the address with all host bits set.
This is the IPv4 broadcast-shaped endpoint of the mathematical range; the API does not decide whether a protocol permits assigning it to a host.
Returns the last address in the range
Examples
Network.parse("192.0.2.9/24").try.last.string # => "192.0.2.255"module Net.IP.Address
Strict parsing and canonicalization of individual IP addresses.
module Net.IP.Network
Strict parsing and canonicalization of CIDR networks.