Modulenetwork-ip-0.3.0.3Haskell2010

Network.IP.Addr

Internet Protocol addressing.

13 types
1 class
43 values

Packagenetwork-ip-0.3.0.3
Exports57
LanguageHaskell2010
LicenceBSD-3-Clause
SourceAddr.hs

Host address

0 declarations

IPv4 address

newtypenewtype IP4

IPv4 address.

Constructors

IP4
- unIP4 :: Word32

Instances36Bounded, Enum, Eq, Data, Num, Ord, …

Bounded IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Enum IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Eq IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Data IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Num IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ord IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Show IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ix IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Bits IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Storable IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Hashable IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Default IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
SizedSerializable IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Printable IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable Inet4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Inet4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Read (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost Net4Addr = IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost (NetAddr IP) = IPDefined in network-ip-0.3.0.3 · Network.IP.Addr

valueanIP4 :: Proxy IP4

IP4 proxy value.

valueip4ToOctets :: IP4 -> (Word8, Word8, Word8, Word8)

The octets of an IPv4 address.

valueip4ToOctetList :: IP4 -> [Word8]

List the octets of an IPv4 address.

valueip4FromOctets :: Word8 -> Word8 -> Word8 -> Word8 -> IP4

Assemble IPv4 address from the octets.

valueip4FromOctetList :: [Word8] -> Maybe IP4

Assemble IPv4 address from the octet list.

valueanyIP4 :: IP4

IPv4 address 0.0.0.0.

valueloopbackIP4 :: IP4

IPv4 address 127.0.0.1.

valuebroadcastIP4 :: IP4

IPv4 address 255.255.255.255.

datadata Range4

IPv4 address range classification (per RFC6890).

Constructors

GeneralIP4
General IPv4 address.
ThisHostIP4
This host on this network.
PrivateUseIP4
Private-Use networks.
SharedSpaceIP4
Shared address space.
LoopbackIP4
Loopback address.
LinkLocalIP4
Link local address.
ReservedIP4
Reserved address.
DSLiteIP4
Dual-Stack Lite.
DocumentationIP4
Reserved for documentation.
IP6To4IP4
6to4.
BenchmarkingIP4
Benchmark testing.
MulticastIP4
Multicast address.
FutureUseIP4
Future use.
BroadcastIP4
Limited broadcast.

Instances6Enum, Eq, Data, Ord, Read, Show

Enum Range4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Eq Range4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Data Range4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ord Range4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read Range4Defined in network-ip-0.3.0.3 · Network.IP.Addr
Show Range4Defined in network-ip-0.3.0.3 · Network.IP.Addr

valueip4Range :: IP4 -> Range4

Determine the address range type.

IPv6 address

newtypenewtype IP6

IPv6 address.

Constructors

IP6
- unIP6 :: Word128

Instances36Bounded, Enum, Eq, Data, Num, Ord, …

Bounded IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Enum IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Eq IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Data IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Num IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ord IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Show IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ix IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Bits IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Storable IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Hashable IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Default IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
SizedSerializable IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Printable IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable Inet6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Inet6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Read (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost Net6Addr = IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost (NetAddr IP) = IPDefined in network-ip-0.3.0.3 · Network.IP.Addr

valueanIP6 :: Proxy IP6

IP6 proxy value.

valueip6ToWords

:: IP6
-> (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)

The 16-bit pieces of an IPv6 address.

valueip6ToWordList :: IP6 -> [Word16]

List the 16-bit pieces of an IPv6 address.

valueip6FromWords

:: Word16
-> Word16
-> Word16
-> Word16
-> Word16
-> Word16
-> Word16
-> Word16
-> IP6

Assemble IPv6 address from the 16-bit pieces.

valueip6FromWordList :: [Word16] -> Maybe IP6

Assemble IPv6 address from the list of 16-bit pieces.

valueanyIP6 :: IP6

IPv6 address ::.

valueloopbackIP6 :: IP6

IPv6 address ::1.

datadata Range6

IPv6 address range classification (per RFC6890).

Constructors

GeneralIP6
General IPv6 address.
AnyIP6
Unspecified address.
LoopbackIP6
Loopback address.
IP4MappedIP6
Mapped IPv4 address.
IP4EmbeddedIP6
Embedded IPv4 address.
DiscardIP6
Discard address.
ReservedIP6
Reserved address.
TeredoIP6
Teredo address.
BenchmarkingIP6
Benchmark testing.
DocumentationIP6
Reserved for documentation.
OrchidIP6
ORCHID address.
IP6To4IP6
6to4.
UniqueLocalIP6
Unique local address.
LinkLocalIP6
Link local address.
MulticastIP6
Multicast address.

Instances6Enum, Eq, Data, Ord, Read, Show

Enum Range6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Eq Range6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Data Range6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ord Range6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read Range6Defined in network-ip-0.3.0.3 · Network.IP.Addr
Show Range6Defined in network-ip-0.3.0.3 · Network.IP.Addr

valueip6Range :: IP6 -> Range6

Determine the address range type.

IP address

datadata IP46 t₄ t₆

IPv4- or IPv6-specific data.

Constructors

IPv4 t₄
IPv6 t₆

Instances16Serializable, Deserializable, Printable, Textual, IsNetAddr, Eq, …

Deserializable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Printable IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual IPDefined in network-ip-0.3.0.3 · Network.IP.Addr
Read (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
(Eq t₄, Eq t₆) => Eq (IP46 t₄ t₆)Defined in network-ip-0.3.0.3 · Network.IP.Addr
(Data t₄, Data t₆) => Data (IP46 t₄ t₆)Defined in network-ip-0.3.0.3 · Network.IP.Addr
(Ord t₄, Ord t₆) => Ord (IP46 t₄ t₆)Defined in network-ip-0.3.0.3 · Network.IP.Addr
(Read t₄, Read t₆) => Read (IP46 t₄ t₆)Defined in network-ip-0.3.0.3 · Network.IP.Addr
(Show t₄, Show t₆) => Show (IP46 t₄ t₆)Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost (NetAddr IP) = IPDefined in network-ip-0.3.0.3 · Network.IP.Addr

valueanIP46 :: Proxy IP46

IP46 proxy value.

valueanIP46Of :: Proxy t₄ -> Proxy t₆ -> Proxy (IP46 t₄ t₆)

IP46 t₄ t₆ proxy value.

typetype IP = IP46 IP4 IP6

IP address.

valueanIP :: Proxy IP

IP proxy value.

Network address

19 declarations

classclass IsNetAddr n where

Network address.

Associated types

type family NetHost n
The address type.

Methods

netHost :: n -> NetHost n
Host address.
netHostIx :: n -> NetHost n
Host index.
netPrefix :: n -> NetHost n
Network prefix.
netMask :: n -> NetHost n
Network mask.
netLength :: n -> Word8
Network prefix length.
netAddr :: NetHost n -> Word8 -> n
Make a network address.
inNetwork :: NetHost n -> n -> Bool
Test if the address is in the network.

Instances3IsNetAddr

IsNetAddr Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr

typetype Net4Addr = NetAddr IP4

IPv4 network address.

typetype Net6Addr = NetAddr IP6

IPv6 network address.

datadata NetAddr a

Network address: host address + network prefix length.

Instances21Eq, Data, Read, Show, Deserializable, Serializable, …

Read Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Read Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr Net4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr Net6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Eq a => Eq (NetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Data a => Data (NetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Show a => Show (NetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable a => Serializable (NetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
SizedSerializable a => SizedSerializable (NetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable a => Printable (NetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
IsNetAddr (NetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost Net4Addr = IP4Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost Net6Addr = IP6Defined in network-ip-0.3.0.3 · Network.IP.Addr
type NetHost (NetAddr IP) = IPDefined in network-ip-0.3.0.3 · Network.IP.Addr

valueaNetAddr :: Proxy NetAddr

NetAddr proxy value.

valueaNetAddrOf :: Proxy a -> Proxy (NetAddr a)

NetAddr a proxy value.

valueaNet4Addr :: Proxy Net4Addr

Net4Addr proxy value.

valueaNet6Addr :: Proxy Net6Addr

Net6Addr proxy value.

valueaNetAddrIP :: Proxy (NetAddr IP)

NetAddr IP proxy value.

valuenet4Addr :: IP4 -> Word8 -> Net4Addr

An alias for netAddr.

valuenet6Addr :: IP6 -> Word8 -> Net6Addr

An alias for netAddr.

valuetoNetAddr46 :: NetAddr IP -> IP46 (NetAddr IP4) (NetAddr IP6)

Pull IP46 from a NetAddr.

valuefromNetAddr46 :: IP46 (NetAddr IP4) (NetAddr IP6) -> NetAddr IP

Push IP46 into a NetAddr.

valueprintNetAddr :: (IsNetAddr n, Printable (NetHost n), Printer p) => n -> p

Print network address (CIDR notation).

valuenet4Parser :: (CharParsing μ, Monad μ, IsNetAddr n, NetHost n ~ IP4) => μ n

IPv4 network address parser (CIDR notation).

valuenet6Parser :: (CharParsing μ, Monad μ, IsNetAddr n, NetHost n ~ IP6) => μ n

IPv6 network address parser (CIDR notation).

valuenetParser :: (IsNetAddr n, NetHost n ~ IP, CharParsing μ, Monad μ) => μ n

IP network address parser (CIDR notation).

valueputNetAddr

:: (IsNetAddr n, Serializable (NetHost n), Serializer s)
=> n
-> s

Serialize a network address (host address followed by 8-bit prefix length).

valuegetNetAddr :: (IsNetAddr n, Deserializable (NetHost n), Deserializer μ) => μ n

Deserialize a network address (host address followed by 8-bit prefix length).

Port number

2 declarations

newtypenewtype InetPort

Port number.

Constructors

InetPort
- unInetPort :: Word16

Instances19Bounded, Enum, Eq, Integral, Data, Num, …

Bounded InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Enum InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Eq InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Integral InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Data InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Num InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Ord InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Read InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Real InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Show InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Ix InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Bits InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Storable InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Hashable InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
SizedSerializable InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Printable InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual InetPortDefined in network-ip-0.3.0.3 · Network.IP.Addr

valueanInetPort :: Proxy InetPort

InetPort proxy value.

Socket address

10 declarations

datadata InetAddr a

Socket address: host address + port number.

Constructors

InetAddr
- inetHost :: a
- inetPort :: !InetPort

Instances16Functor, Eq, Data, Ord, Read, Show, …

Functor InetAddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Printable Inet4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Printable Inet6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Inet4AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Textual Inet6AddrDefined in network-ip-0.3.0.3 · Network.IP.Addr
Eq a => Eq (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Data a => Data (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Ord a => Ord (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Read a => Read (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Show a => Show (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Hashable a => Hashable (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Deserializable a => Deserializable (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Serializable a => Serializable (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
SizedSerializable a => SizedSerializable (InetAddr a)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Printable (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr
Textual (InetAddr IP)Defined in network-ip-0.3.0.3 · Network.IP.Addr

typetype Inet4Addr = InetAddr IP4

IPv4 socket address.

typetype Inet6Addr = InetAddr IP6

IPv6 socket address.

valueanInetAddr :: Proxy InetAddr

InetAddr proxy value.

valueanInetAddrOf :: Proxy a -> Proxy (InetAddr a)

InetAddr a proxy value.

valueanInet4Addr :: Proxy Inet4Addr

Inet4Addr proxy value.

valueanInet6Addr :: Proxy Inet6Addr

Inet6Addr proxy value.

valueanInetAddrIP :: Proxy (InetAddr IP)

InetAddr IP proxy value.

valuetoInetAddr46 :: InetAddr IP -> IP46 (InetAddr IP4) (InetAddr IP6)

Pull IP46 from an InetAddr.

valuefromInetAddr46 :: IP46 (InetAddr IP4) (InetAddr IP6) -> InetAddr IP

Push IP46 into an InetAddr.