Data.IP

Data structures to express IPv4, IPv6 and IP range.

IP data

data IP

A unified IP data for IP and IP. To create this, use the data constructors. Or use read "192.0.2.1" :: IP, for example. Also, "192.0.2.1" can be used as literal with OverloadedStrings.

>>> (read "192.0.2.1" :: IP) == IPv4 (read "192.0.2.1" :: IPv4)
True
>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == IPv6 (read "2001:db8:00:00:00:00:00:01" :: IPv6)
True

Constructors

IPv4

Fields

• ipv4 :: IPv4

IPv6

Fields

• ipv6 :: IPv6

Instances

Data IP

Defined in Data.IP.Addr

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IP -> c IP

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IP

toConstr :: IP -> Constr

dataTypeOf :: IP -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IP)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IP)

gmapT :: (forall b. Data b => b -> b) -> IP -> IP

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IP -> r

gmapQ :: (forall d. Data d => d -> u) -> IP -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IP -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IP -> m IP

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IP -> m IP

IsString IP

Defined in Data.IP.Addr

Methods

fromString :: String -> IP

Enum IP

Defined in Data.IP.Addr

Methods

succ :: IP -> IP

pred :: IP -> IP

toEnum :: Int -> IP

fromEnum :: IP -> Int

enumFrom :: IP -> [IP]

enumFromThen :: IP -> IP -> [IP]

enumFromTo :: IP -> IP -> [IP]

enumFromThenTo :: IP -> IP -> IP -> [IP]

Generic IP

Defined in Data.IP.Addr

Associated Types

type Rep IP :: Type -> Type

Methods

from :: IP -> Rep IP x

to :: Rep IP x -> IP

Read IP

Defined in Data.IP.Addr

Methods

readsPrec :: Int -> ReadS IP

readList :: ReadS [IP]

readPrec :: ReadPrec IP

readListPrec :: ReadPrec [IP]

Show IP

Defined in Data.IP.Addr

Methods

showsPrec :: Int -> IP -> ShowS

show :: IP -> String

showList :: [IP] -> ShowS

Eq IP

Equality over IP addresses. Correctly compare IPv4 and IPv4-embedded-in-IPv6 addresses.

>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == (read "2001:db8:00:00:00:00:00:01" :: IP)
True
>>> (read "2001:db8:00:00:00:00:00:01" :: IP) == (read "2001:db8:00:00:00:00:00:05" :: IP)
False
>>> (read "127.0.0.1" :: IP) == (read "127.0.0.1" :: IP)
True
>>> (read "127.0.0.1" :: IP) == (read "10.0.0.1" :: IP)
False
>>> (read "::ffff:127.0.0.1" :: IP) == (read "127.0.0.1" :: IP)
True
>>> (read "::ffff:127.0.0.1" :: IP) == (read "127.0.0.9" :: IP)
False
>>> (read "::ffff:127.0.0.1" :: IP) >= (read "127.0.0.1" :: IP)
True
>>> (read "::ffff:127.0.0.1" :: IP) <= (read "127.0.0.1" :: IP)
True

Defined in Data.IP.Addr

Methods

(==) :: IP -> IP -> Bool

(/=) :: IP -> IP -> Bool

Ord IP

Defined in Data.IP.Addr

Methods

compare :: IP -> IP -> Ordering

(<) :: IP -> IP -> Bool

(<=) :: IP -> IP -> Bool

(>) :: IP -> IP -> Bool

(>=) :: IP -> IP -> Bool

max :: IP -> IP -> IP

min :: IP -> IP -> IP

type Rep IP

Defined in Data.IP.Addr

type Rep IP = D1 ('MetaData "IP" "Data.IP.Addr" "iproute-1.7.14-1zIIH75j1FAJJMN1nmSNNv" 'False) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv4") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPv4)) :+: C1 ('MetaCons "IPv6" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IPv6)))

IPv4

data IPv4

The abstract data type to express an IPv4 address. To create this, use toIPv4. Or use read "192.0.2.1" :: IP, for example. Also, "192.0.2.1" can be used as literal with OverloadedStrings.

>>> read "192.0.2.1" :: IPv4
192.0.2.1

Instances

Data IPv4

Defined in Data.IP.Addr

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IPv4 -> c IPv4

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IPv4

toConstr :: IPv4 -> Constr

dataTypeOf :: IPv4 -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IPv4)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IPv4)

gmapT :: (forall b. Data b => b -> b) -> IPv4 -> IPv4

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IPv4 -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IPv4 -> r

gmapQ :: (forall d. Data d => d -> u) -> IPv4 -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IPv4 -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IPv4 -> m IPv4

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IPv4 -> m IPv4

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IPv4 -> m IPv4

IsString IPv4

Defined in Data.IP.Addr

Methods

fromString :: String -> IPv4

Bounded IPv4

Defined in Data.IP.Addr

Methods

minBound :: IPv4

maxBound :: IPv4

Enum IPv4

Defined in Data.IP.Addr

Methods

succ :: IPv4 -> IPv4

pred :: IPv4 -> IPv4

toEnum :: Int -> IPv4

fromEnum :: IPv4 -> Int

enumFrom :: IPv4 -> [IPv4]

enumFromThen :: IPv4 -> IPv4 -> [IPv4]

enumFromTo :: IPv4 -> IPv4 -> [IPv4]

enumFromThenTo :: IPv4 -> IPv4 -> IPv4 -> [IPv4]

Generic IPv4

Defined in Data.IP.Addr

Associated Types

type Rep IPv4 :: Type -> Type

Methods

from :: IPv4 -> Rep IPv4 x

to :: Rep IPv4 x -> IPv4

Read IPv4

Defined in Data.IP.Addr

Methods

readsPrec :: Int -> ReadS IPv4

readList :: ReadS [IPv4]

readPrec :: ReadPrec IPv4

readListPrec :: ReadPrec [IPv4]

Show IPv4

Defined in Data.IP.Addr

Methods

showsPrec :: Int -> IPv4 -> ShowS

show :: IPv4 -> String

showList :: [IPv4] -> ShowS

Eq IPv4

Defined in Data.IP.Addr

Methods

(==) :: IPv4 -> IPv4 -> Bool

(/=) :: IPv4 -> IPv4 -> Bool

Ord IPv4

Defined in Data.IP.Addr

Methods

compare :: IPv4 -> IPv4 -> Ordering

(<) :: IPv4 -> IPv4 -> Bool

(<=) :: IPv4 -> IPv4 -> Bool

(>) :: IPv4 -> IPv4 -> Bool

(>=) :: IPv4 -> IPv4 -> Bool

max :: IPv4 -> IPv4 -> IPv4

min :: IPv4 -> IPv4 -> IPv4

Addr IPv4

Defined in Data.IP.Op

Methods

masked :: IPv4 -> IPv4 -> IPv4

intToMask :: Int -> IPv4

Routable IPv4

Defined in Data.IP.RouteTable.Internal

Methods

intToTBit :: Int -> IPv4

isZero :: IPv4 -> IPv4 -> Bool

IsString (AddrRange IPv4)

Defined in Data.IP.Range

Methods

fromString :: String -> AddrRange IPv4

Read (AddrRange IPv4)

Defined in Data.IP.Range

Methods

readsPrec :: Int -> ReadS (AddrRange IPv4)

readList :: ReadS [AddrRange IPv4]

readPrec :: ReadPrec (AddrRange IPv4)

readListPrec :: ReadPrec [AddrRange IPv4]

type Rep IPv4

Defined in Data.IP.Addr

type Rep IPv4 = D1 ('MetaData "IPv4" "Data.IP.Addr" "iproute-1.7.14-1zIIH75j1FAJJMN1nmSNNv" 'True) (C1 ('MetaCons "IP4" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IPv4Addr)))

toIPv4 :: [Int] -> IPv4

The toIPv4 function returns the IP address corresponding to the given list of Int octets. The function is strict in the four elements of the list. An error is returned if the list has a differnet length. The input elements are silently truncated to their 8 least-significant bits before they are combined to form the IPv4 address.

>>> toIPv4 [192,0,2,1]
192.0.2.1

toIPv4w :: Word32 -> IPv4

The toIPv4w function constructs the IP address corresponding to the given Word32 value. Unlike the fromHostAddress function, it is strict in the input value, which here is in host byte order.

>>> toIPv4w 0xc0000201
192.0.2.1

Since: 1.7.9

fromIPv4 :: IPv4 -> [Int]

The fromIPv4 function returns the list of four Int octets corresponding to the given IP address.

>>> fromIPv4 (toIPv4 [192,0,2,1])
[192,0,2,1]

fromIPv4w :: IPv4 -> Word32

The fromIPv4w function returns a single Word32 value corresponding to the given the IP address. Unlike the toHostAddress function, the returned value is strictly evaluated, and is not converted to network byte order.

>>> fromIPv4w (toIPv4 [0xc0,0,2,1]) == 0xc0000201
True

Since: 1.7.9

fromHostAddress :: HostAddress -> IPv4

The fromHostAddress function converts HostAddress to IP.

toHostAddress :: IPv4 -> HostAddress

The toHostAddress function converts IP to HostAddress.

IPv6

data IPv6

The abstract data type to express an IPv6 address. To create this, use toIPv6. Or use read "2001:DB8::1" :: IP, for example. Also, "2001:DB8::1" can be used as literal with OverloadedStrings.

>>> read "2001:db8:00:00:00:00:00:01" :: IPv6
2001:db8::1
>>> read "2001:db8:11e:c00::101" :: IPv6
2001:db8:11e:c00::101
>>> read "2001:db8:11e:c00:aa:bb:192.0.2.1" :: IPv6
2001:db8:11e:c00:aa:bb:c000:201
>>> read "2001:db8::192.0.2.1" :: IPv6
2001:db8::c000:201
>>> read "0::ffff:192.0.2.1" :: IPv6
::ffff:192.0.2.1
>>> read "0::0:c000:201" :: IPv6
::192.0.2.1
>>> read "::0.0.0.1" :: IPv6
::1

Instances

Data IPv6

Defined in Data.IP.Addr

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IPv6 -> c IPv6

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IPv6

toConstr :: IPv6 -> Constr

dataTypeOf :: IPv6 -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IPv6)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IPv6)

gmapT :: (forall b. Data b => b -> b) -> IPv6 -> IPv6

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IPv6 -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IPv6 -> r

gmapQ :: (forall d. Data d => d -> u) -> IPv6 -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IPv6 -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IPv6 -> m IPv6

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IPv6 -> m IPv6

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IPv6 -> m IPv6

IsString IPv6

Defined in Data.IP.Addr

Methods

fromString :: String -> IPv6

Bounded IPv6

Defined in Data.IP.Addr

Methods

minBound :: IPv6

maxBound :: IPv6

Enum IPv6

Defined in Data.IP.Addr

Methods

succ :: IPv6 -> IPv6

pred :: IPv6 -> IPv6

toEnum :: Int -> IPv6

fromEnum :: IPv6 -> Int

enumFrom :: IPv6 -> [IPv6]

enumFromThen :: IPv6 -> IPv6 -> [IPv6]

enumFromTo :: IPv6 -> IPv6 -> [IPv6]

enumFromThenTo :: IPv6 -> IPv6 -> IPv6 -> [IPv6]

Generic IPv6

Defined in Data.IP.Addr

Associated Types

type Rep IPv6 :: Type -> Type

Methods

from :: IPv6 -> Rep IPv6 x

to :: Rep IPv6 x -> IPv6

Read IPv6

Defined in Data.IP.Addr

Methods

readsPrec :: Int -> ReadS IPv6

readList :: ReadS [IPv6]

readPrec :: ReadPrec IPv6

readListPrec :: ReadPrec [IPv6]

Show IPv6

Defined in Data.IP.Addr

Methods

showsPrec :: Int -> IPv6 -> ShowS

show :: IPv6 -> String

showList :: [IPv6] -> ShowS

Eq IPv6

Defined in Data.IP.Addr

Methods

(==) :: IPv6 -> IPv6 -> Bool

(/=) :: IPv6 -> IPv6 -> Bool

Ord IPv6

Defined in Data.IP.Addr

Methods

compare :: IPv6 -> IPv6 -> Ordering

(<) :: IPv6 -> IPv6 -> Bool

(<=) :: IPv6 -> IPv6 -> Bool

(>) :: IPv6 -> IPv6 -> Bool

(>=) :: IPv6 -> IPv6 -> Bool

max :: IPv6 -> IPv6 -> IPv6

min :: IPv6 -> IPv6 -> IPv6

Addr IPv6

Defined in Data.IP.Op

Methods

masked :: IPv6 -> IPv6 -> IPv6

intToMask :: Int -> IPv6

Routable IPv6

Defined in Data.IP.RouteTable.Internal

Methods

intToTBit :: Int -> IPv6

isZero :: IPv6 -> IPv6 -> Bool

IsString (AddrRange IPv6)

Defined in Data.IP.Range

Methods

fromString :: String -> AddrRange IPv6

Read (AddrRange IPv6)

Defined in Data.IP.Range

Methods

readsPrec :: Int -> ReadS (AddrRange IPv6)

readList :: ReadS [AddrRange IPv6]

readPrec :: ReadPrec (AddrRange IPv6)

readListPrec :: ReadPrec [AddrRange IPv6]

type Rep IPv6

Defined in Data.IP.Addr

type Rep IPv6 = D1 ('MetaData "IPv6" "Data.IP.Addr" "iproute-1.7.14-1zIIH75j1FAJJMN1nmSNNv" 'True) (C1 ('MetaCons "IP6" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IPv6Addr)))

toIPv6 :: [Int] -> IPv6

The toIPv6 function returns the IP address corresponding to the given list of eight 16-bit Ints. The function is strict in the eight elements of the list. An error is returned if the list has a differnet length. The input elements are in host byte order and are silently truncated to their 16 least-signicant bits before they are combined to form the IPv6 address.

>>> toIPv6 [0x2001,0xDB8,0,0,0,0,0,1]
2001:db8::1

toIPv6b :: [Int] -> IPv6

The toIPv6b function returns the IPv6 address corresponding to the given list of sixteen Int octets. The function is strict in the sixteen elements of the list. An error is returned if the list has a differnet length. The input elements are silently truncated to their 8 least-signicant bits before they are combined to form the IPv6 address.

>>> toIPv6b [0x20,0x01,0xD,0xB8,0,0,0,0,0,0,0,0,0,0,0,1]
2001:db8::1

toIPv6w :: (Word32, Word32, Word32, Word32) -> IPv6

The toIPv6w function constructs the IP address corresponding to the given four-tuple of host byte order Word32 values. This function differs from the fromHostAddress6 function only in the fact that it is strict in the elements of the tuple.

>>> toIPv6w (0x20010DB8,0x0,0x0,0x1)
2001:db8::1

Since: 1.7.9

fromIPv6 :: IPv6 -> [Int]

The fromIPv6 function returns a list eight Ints in host byte order corresponding to the eight 16-bit fragments of the given IPv6 address.

>>> fromIPv6 (toIPv6 [0x2001,0xDB8,0,0,0,0,0,1])
[8193,3512,0,0,0,0,0,1]

fromIPv6b :: IPv6 -> [Int]

The fromIPv6b function returns the 16 Int octets corresponding to the 16 bytes of the given IPv6 address.

>>> fromIPv6b (toIPv6b [0x20,0x01,0xD,0xB8,0,0,0,0,0,0,0,0,0,0,0,1])
[32,1,13,184,0,0,0,0,0,0,0,0,0,0,0,1]

fromIPv6w :: IPv6 -> (Word32, Word32, Word32, Word32)

The fromIPv6w function returns a four-tuple of Word32 values in host byte order corresponding to the given IP address. This is identical to the toHostAddress6 function, except that the elements of four-tuple are first strictly evaluated.

>>> fromIPv6w (toIPv6 [0x2001,0xDB8,0,0,0,0,0,1]) == (0x20010DB8, 0, 0, 1)
True

Since: 1.7.9

fromHostAddress6 :: HostAddress6 -> IPv6

The fromHostAddress6 function converts HostAddress6 to IP.

toHostAddress6 :: IPv6 -> HostAddress6

The toHostAddress6 function converts IP to HostAddress6.

Converters

ipv4ToIPv6 :: IPv4 -> IPv6

Convert IPv4 address to IPv4-embedded-in-IPv6

fromSockAddr :: SockAddr -> Maybe (IP, PortNumber)

Convert SockAddr to IP.

Since: 1.7.4.

toSockAddr :: (IP, PortNumber) -> SockAddr

Convert IP to SockAddr.

Since: 1.7.8.

IP range data

data IPRange

A unified data for AddrRange IP and AddrRange IP. To create this, use read "192.0.2.0/24" :: IPRange. Also, "192.0.2.0/24" can be used as literal with OverloadedStrings.

>>> (read "192.0.2.1/24" :: IPRange) == IPv4Range (read "192.0.2.0/24" :: AddrRange IPv4)
True
>>> (read "2001:db8:00:00:00:00:00:01/48" :: IPRange) == IPv6Range (read "2001:db8:00:00:00:00:00:01/48" :: AddrRange IPv6)
True

Constructors

IPv4Range

Fields

• ipv4range :: AddrRange IPv4

IPv6Range

Fields

• ipv6range :: AddrRange IPv6

Instances

Data IPRange

Defined in Data.IP.Range

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IPRange -> c IPRange

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IPRange

toConstr :: IPRange -> Constr

dataTypeOf :: IPRange -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c IPRange)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IPRange)

gmapT :: (forall b. Data b => b -> b) -> IPRange -> IPRange

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IPRange -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IPRange -> r

gmapQ :: (forall d. Data d => d -> u) -> IPRange -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> IPRange -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IPRange -> m IPRange

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IPRange -> m IPRange

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IPRange -> m IPRange

IsString IPRange

Defined in Data.IP.Range

Methods

fromString :: String -> IPRange

Generic IPRange

Defined in Data.IP.Range

Associated Types

type Rep IPRange :: Type -> Type

Methods

from :: IPRange -> Rep IPRange x

to :: Rep IPRange x -> IPRange

Read IPRange

Defined in Data.IP.Range

Methods

readsPrec :: Int -> ReadS IPRange

readList :: ReadS [IPRange]

readPrec :: ReadPrec IPRange

readListPrec :: ReadPrec [IPRange]

Show IPRange

Defined in Data.IP.Range

Methods

showsPrec :: Int -> IPRange -> ShowS

show :: IPRange -> String

showList :: [IPRange] -> ShowS

Eq IPRange

Defined in Data.IP.Range

Methods

(==) :: IPRange -> IPRange -> Bool

(/=) :: IPRange -> IPRange -> Bool

Ord IPRange

Defined in Data.IP.Range

Methods

compare :: IPRange -> IPRange -> Ordering

(<) :: IPRange -> IPRange -> Bool

(<=) :: IPRange -> IPRange -> Bool

(>) :: IPRange -> IPRange -> Bool

(>=) :: IPRange -> IPRange -> Bool

max :: IPRange -> IPRange -> IPRange

min :: IPRange -> IPRange -> IPRange

type Rep IPRange

Defined in Data.IP.Range

type Rep IPRange = D1 ('MetaData "IPRange" "Data.IP.Range" "iproute-1.7.14-1zIIH75j1FAJJMN1nmSNNv" 'False) (C1 ('MetaCons "IPv4Range" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv4range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (AddrRange IPv4))) :+: C1 ('MetaCons "IPv6Range" 'PrefixI 'True) (S1 ('MetaSel ('Just "ipv6range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (AddrRange IPv6))))

data AddrRange a

The Addr range consists of an address, a contiguous mask, and mask length. The contiguous mask and the mask length are essentially same information but contained for pre calculation.

To create this, use makeAddrRange or read "192.0.2.0/24" :: AddrRange IP. Also, "192.0.2.0/24" can be used as literal with OverloadedStrings.

>>> read "192.0.2.1/24" :: AddrRange IPv4
192.0.2.0/24
>>> read "2001:db8:00:00:00:00:00:01/48" :: AddrRange IPv6
2001:db8::/48

Instances

Data a => Data (AddrRange a)

Defined in Data.IP.Range

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AddrRange a -> c (AddrRange a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (AddrRange a)

toConstr :: AddrRange a -> Constr

dataTypeOf :: AddrRange a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (AddrRange a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (AddrRange a))

gmapT :: (forall b. Data b => b -> b) -> AddrRange a -> AddrRange a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AddrRange a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AddrRange a -> r

gmapQ :: (forall d. Data d => d -> u) -> AddrRange a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AddrRange a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AddrRange a -> m (AddrRange a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AddrRange a -> m (AddrRange a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AddrRange a -> m (AddrRange a)

IsString (AddrRange IPv4)

Defined in Data.IP.Range

Methods

fromString :: String -> AddrRange IPv4

IsString (AddrRange IPv6)

Defined in Data.IP.Range

Methods

fromString :: String -> AddrRange IPv6

Generic (AddrRange a)

Defined in Data.IP.Range

Associated Types

type Rep (AddrRange a) :: Type -> Type

Methods

from :: AddrRange a -> Rep (AddrRange a) x

to :: Rep (AddrRange a) x -> AddrRange a

Read (AddrRange IPv4)

Defined in Data.IP.Range

Methods

readsPrec :: Int -> ReadS (AddrRange IPv4)

readList :: ReadS [AddrRange IPv4]

readPrec :: ReadPrec (AddrRange IPv4)

readListPrec :: ReadPrec [AddrRange IPv4]

Read (AddrRange IPv6)

Defined in Data.IP.Range

Methods

readsPrec :: Int -> ReadS (AddrRange IPv6)

readList :: ReadS [AddrRange IPv6]

readPrec :: ReadPrec (AddrRange IPv6)

readListPrec :: ReadPrec [AddrRange IPv6]

Show a => Show (AddrRange a)

Defined in Data.IP.Range

Methods

showsPrec :: Int -> AddrRange a -> ShowS

show :: AddrRange a -> String

showList :: [AddrRange a] -> ShowS

Eq a => Eq (AddrRange a)

Defined in Data.IP.Range

Methods

(==) :: AddrRange a -> AddrRange a -> Bool

(/=) :: AddrRange a -> AddrRange a -> Bool

Ord a => Ord (AddrRange a)

Defined in Data.IP.Range

Methods

compare :: AddrRange a -> AddrRange a -> Ordering

(<) :: AddrRange a -> AddrRange a -> Bool

(<=) :: AddrRange a -> AddrRange a -> Bool

(>) :: AddrRange a -> AddrRange a -> Bool

(>=) :: AddrRange a -> AddrRange a -> Bool

max :: AddrRange a -> AddrRange a -> AddrRange a

min :: AddrRange a -> AddrRange a -> AddrRange a

type Rep (AddrRange a)

Defined in Data.IP.Range

type Rep (AddrRange a) = D1 ('MetaData "AddrRange" "Data.IP.Range" "iproute-1.7.14-1zIIH75j1FAJJMN1nmSNNv" 'False) (C1 ('MetaCons "AddrRange" 'PrefixI 'True) (S1 ('MetaSel ('Just "addr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: (S1 ('MetaSel ('Just "mask") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "mlen") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int))))

Address class

class Eq a => Addr a where

>>> toIPv4 [127,0,2,1] `masked` intToMask 7
126.0.0.0

Methods

masked :: a -> a -> a

The masked function takes an Addr and a contiguous mask and returned a masked Addr.

intToMask :: Int -> a

The intToMask function takes an Int representing the number of bits to be set in the returned contiguous mask. When this integer is positive the bits will be starting from the MSB and from the LSB otherwise.

>>> intToMask 16 :: IPv4
255.255.0.0

>>> intToMask (-16) :: IPv4
0.0.255.255

>>> intToMask 16 :: IPv6
ffff::

>>> intToMask (-16) :: IPv6
::ffff

Instances

Addr IPv4

Defined in Data.IP.Op

Methods

masked :: IPv4 -> IPv4 -> IPv4

intToMask :: Int -> IPv4

Addr IPv6

Defined in Data.IP.Op

Methods

masked :: IPv6 -> IPv6 -> IPv6

intToMask :: Int -> IPv6

makeAddrRange :: Addr a => a -> Int -> AddrRange a

The makeAddrRange functions takes an Addr address and a mask length. It creates a bit mask from the mask length and masks the Addr address, then returns AddrRange made of them.

>>> makeAddrRange (toIPv4 [127,0,2,1]) 8
127.0.0.0/8
>>> makeAddrRange (toIPv6 [0x2001,0xDB8,0,0,0,0,0,1]) 8
2000::/8

(>:>) :: Addr a => AddrRange a -> AddrRange a -> Bool

The >:> operator takes two AddrRange. It returns True if the first AddrRange contains the second AddrRange. Otherwise, it returns False.

>>> makeAddrRange ("127.0.2.1" :: IPv4) 8 >:> makeAddrRange "127.0.2.1" 24
True
>>> makeAddrRange ("127.0.2.1" :: IPv4) 24 >:> makeAddrRange "127.0.2.1" 8
False
>>> makeAddrRange ("2001:DB8::1" :: IPv6) 16 >:> makeAddrRange "2001:DB8::1" 32
True
>>> makeAddrRange ("2001:DB8::1" :: IPv6) 32 >:> makeAddrRange "2001:DB8::1" 16
False

isMatchedTo :: Addr a => a -> AddrRange a -> Bool

The isMatchedTo function take an Addr address and an AddrRange, and returns True if the range contains the address.

>>> ("127.0.2.0" :: IPv4) `isMatchedTo` makeAddrRange "127.0.2.1" 24
True
>>> ("127.0.2.0" :: IPv4) `isMatchedTo` makeAddrRange "127.0.2.1" 32
False
>>> ("2001:DB8::1" :: IPv6) `isMatchedTo` makeAddrRange "2001:DB8::1" 32
True
>>> ("2001:DB8::" :: IPv6) `isMatchedTo` makeAddrRange "2001:DB8::1" 128
False

addrRangePair :: Addr a => AddrRange a -> (a, Int)

The unmakeAddrRange functions take a AddrRange and returns the network address and a mask length.

>>> addrRangePair ("127.0.0.0/8" :: AddrRange IPv4)
(127.0.0.0,8)
>>> addrRangePair ("2000::/8" :: AddrRange IPv6)
(2000::,8)

ipv4RangeToIPv6 :: AddrRange IPv4 -> AddrRange IPv6

Convert IPv4 range to IPV4-embedded-in-IPV6 range