Safe Haskell	None
Language	Haskell2010

Net.IPv4

Contents

Conversion Functions
Special IP Addresses
Range Predicates
Textual Conversion
Types

Description

An IPv4 data type

This module provides the IPv4 data type and functions for working with it. There are also encoding and decoding functions provided in this module, but they should be imported from Net.IPv4.Text and Net.IPv4.ByteString.Char8 instead. They are defined here so that the FromJSON and ToJSON instances can use them.

At some point, a highly efficient IPv4-to-ByteString function needs to be added to this module to take advantage of aeson's new toEncoding method.

Synopsis

Conversion Functions

ipv4 :: Word8 -> Word8 -> Word8 -> Word8 -> IPv4 Source #

Create an IPv4 address from four octets. The first argument is the most significant octet. The last argument is the least significant. Since IP addresses are commonly written using dot-decimal notation, this is the recommended way to create an IP address. Additionally, it is used for the Show and Read instances of IPv4 to help keep things readable in GHCi.

>>> let addr = ipv4 192 168 1 1
>>> addr
ipv4 192 168 1 1
>>> getIPv4 addr
3232235777

fromOctets :: Word8 -> Word8 -> Word8 -> Word8 -> IPv4 Source #

An alias for the ipv4 smart constructor.

fromTupleOctets :: (Word8, Word8, Word8, Word8) -> IPv4 Source #

An uncurried variant of fromOctets.

toOctets :: IPv4 -> (Word8, Word8, Word8, Word8) Source #

Convert an IPv4 address into a quadruple of octets. The first element in the quadruple is the most significant octet. The last element is the least significant octet.

Special IP Addresses

any :: IPv4 Source #

The IP address representing any host: 0.0.0.0

loopback :: IPv4 Source #

The loopback IP address: 127.0.0.1

broadcast :: IPv4 Source #

The broadcast IP address: 255.255.255.255

Range Predicates

private :: IPv4 -> Bool Source #

Checks to see if the IPv4 address belongs to a private network. The three private networks that are checked are 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16.

reserved :: IPv4 -> Bool Source #

Checks to see if the IPv4 address belongs to a reserved network. This includes the three private networks that private checks along with several other ranges that are not used on the public Internet.

public :: IPv4 -> Bool Source #

Checks to see if the IPv4 address is publicly routable.

public x == not (reserved x)

Textual Conversion

Text

encode :: IPv4 -> Text Source #

Encode an IPv4 address to Text using dot-decimal notation:

>>> T.putStrLn (encode (ipv4 192 168 2 47))
192.168.2.47

decode :: Text -> Maybe IPv4 Source #

Decode an IPv4 address.

builder :: IPv4 -> Builder Source #

Encode an IPv4 address to a text Builder.

reader :: Reader IPv4 Source #

parser :: Parser IPv4 Source #

UTF-8 ByteString

encodeUtf8 :: IPv4 -> ByteString Source #

Encode an IPv4 address to a UTF-8 encoded ByteString.

decodeUtf8 :: ByteString -> Maybe IPv4 Source #

builderUtf8 :: IPv4 -> Builder Source #

parserUtf8 :: Parser IPv4 Source #

String

These functions exist for the convenience of those who need a String representation of an IPv4 address. Using them is discouraged unless the end user is working with a library that can only use String to deal with textual data (such as pandoc, hxr, or network).

encodeString :: IPv4 -> String Source #

decodeString :: String -> Maybe IPv4 Source #

Printing

print :: IPv4 -> IO () Source #

Types

newtype IPv4 Source #

A 32-bit Internet Protocol version 4 address. To use this with the network library, it is necessary to use Network.Socket.htonl to convert the underlying Word32 from host byte order to network byte order.

Constructors

IPv4
Fields getIPv4 :: Word32

Instances

Bounded IPv4 Source #
Methods minBound :: IPv4 # maxBound :: IPv4 #
Enum IPv4 Source #
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] #
Eq IPv4 Source #
Methods (==) :: IPv4 -> IPv4 -> Bool # (/=) :: IPv4 -> IPv4 -> Bool #
Ord IPv4 Source #
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 #
Read IPv4 Source #
Methods readsPrec :: Int -> ReadS IPv4 # readList :: ReadS [IPv4] # readPrec :: ReadPrec IPv4 # readListPrec :: ReadPrec [IPv4] #
Show IPv4 Source #
Methods showsPrec :: Int -> IPv4 -> ShowS # show :: IPv4 -> String # showList :: [IPv4] -> ShowS #
Generic IPv4 Source #
Associated Types type Rep IPv4 :: * -> * # Methods from :: IPv4 -> Rep IPv4 x # to :: Rep IPv4 x -> IPv4 #
Hashable IPv4 Source #
Methods hashWithSalt :: Int -> IPv4 -> Int # hash :: IPv4 -> Int #
ToJSON IPv4 Source #
Methods toJSON :: IPv4 -> Value # toEncoding :: IPv4 -> Encoding # toJSONList :: [IPv4] -> Value # toEncodingList :: [IPv4] -> Encoding #
ToJSONKey IPv4 Source #
Methods toJSONKey :: ToJSONKeyFunction IPv4 # toJSONKeyList :: ToJSONKeyFunction [IPv4] #
FromJSON IPv4 Source #
Methods parseJSON :: Value -> Parser IPv4 # parseJSONList :: Value -> Parser [IPv4] #
FromJSONKey IPv4 Source #
Methods fromJSONKey :: FromJSONKeyFunction IPv4 # fromJSONKeyList :: FromJSONKeyFunction [IPv4] #
Storable IPv4 Source #
Methods sizeOf :: IPv4 -> Int # alignment :: IPv4 -> Int # peekElemOff :: Ptr IPv4 -> Int -> IO IPv4 # pokeElemOff :: Ptr IPv4 -> Int -> IPv4 -> IO () # peekByteOff :: Ptr b -> Int -> IO IPv4 # pokeByteOff :: Ptr b -> Int -> IPv4 -> IO () # peek :: Ptr IPv4 -> IO IPv4 # poke :: Ptr IPv4 -> IPv4 -> IO () #
Bits IPv4 Source #
Methods (.&.) :: IPv4 -> IPv4 -> IPv4 # (.\|.) :: IPv4 -> IPv4 -> IPv4 # xor :: IPv4 -> IPv4 -> IPv4 # complement :: IPv4 -> IPv4 # shift :: IPv4 -> Int -> IPv4 # rotate :: IPv4 -> Int -> IPv4 # zeroBits :: IPv4 # bit :: Int -> IPv4 # setBit :: IPv4 -> Int -> IPv4 # clearBit :: IPv4 -> Int -> IPv4 # complementBit :: IPv4 -> Int -> IPv4 # testBit :: IPv4 -> Int -> Bool # bitSizeMaybe :: IPv4 -> Maybe Int # bitSize :: IPv4 -> Int # isSigned :: IPv4 -> Bool # shiftL :: IPv4 -> Int -> IPv4 # unsafeShiftL :: IPv4 -> Int -> IPv4 # shiftR :: IPv4 -> Int -> IPv4 # unsafeShiftR :: IPv4 -> Int -> IPv4 # rotateL :: IPv4 -> Int -> IPv4 # rotateR :: IPv4 -> Int -> IPv4 # popCount :: IPv4 -> Int #
FiniteBits IPv4 Source #
Methods finiteBitSize :: IPv4 -> Int # countLeadingZeros :: IPv4 -> Int # countTrailingZeros :: IPv4 -> Int #
Prim IPv4 Source #
Methods sizeOf# :: IPv4 -> Int# # alignment# :: IPv4 -> Int# # indexByteArray# :: ByteArray# -> Int# -> IPv4 # readByteArray# :: MutableByteArray# s -> Int# -> State# s -> (#TupleRep [RuntimeRep], LiftedRep, State# s, IPv4#) # writeByteArray# :: MutableByteArray# s -> Int# -> IPv4 -> State# s -> State# s # setByteArray# :: MutableByteArray# s -> Int# -> Int# -> IPv4 -> State# s -> State# s # indexOffAddr# :: Addr# -> Int# -> IPv4 # readOffAddr# :: Addr# -> Int# -> State# s -> (#TupleRep [RuntimeRep], LiftedRep, State# s, IPv4#) # writeOffAddr# :: Addr# -> Int# -> IPv4 -> State# s -> State# s # setOffAddr# :: Addr# -> Int# -> Int# -> IPv4 -> State# s -> State# s #
Unbox IPv4 Source #

Vector Vector IPv4 Source #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) IPv4 -> m (Vector IPv4) # basicUnsafeThaw :: PrimMonad m => Vector IPv4 -> m (Mutable Vector (PrimState m) IPv4) # basicLength :: Vector IPv4 -> Int # basicUnsafeSlice :: Int -> Int -> Vector IPv4 -> Vector IPv4 # basicUnsafeIndexM :: Monad m => Vector IPv4 -> Int -> m IPv4 # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) IPv4 -> Vector IPv4 -> m () # elemseq :: Vector IPv4 -> IPv4 -> b -> b #
MVector MVector IPv4 Source #
Methods basicLength :: MVector s IPv4 -> Int # basicUnsafeSlice :: Int -> Int -> MVector s IPv4 -> MVector s IPv4 # basicOverlaps :: MVector s IPv4 -> MVector s IPv4 -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) IPv4) # basicInitialize :: PrimMonad m => MVector (PrimState m) IPv4 -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> IPv4 -> m (MVector (PrimState m) IPv4) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) IPv4 -> Int -> m IPv4 # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) IPv4 -> Int -> IPv4 -> m () # basicClear :: PrimMonad m => MVector (PrimState m) IPv4 -> m () # basicSet :: PrimMonad m => MVector (PrimState m) IPv4 -> IPv4 -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) IPv4 -> MVector (PrimState m) IPv4 -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) IPv4 -> MVector (PrimState m) IPv4 -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) IPv4 -> Int -> m (MVector (PrimState m) IPv4) #
type Rep IPv4 Source #
type Rep IPv4 = D1 * (MetaData "IPv4" "Net.IPv4" "ip-1.1.2-ADz8j8LLtdHj5dfu4aH9S" True) (C1 * (MetaCons "IPv4" PrefixI True) (S1 * (MetaSel (Just Symbol "getIPv4") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word32)))
data Vector IPv4 Source #
data Vector IPv4 = V_IPv4 (Vector IPv4)
data MVector s IPv4 Source #
data MVector s IPv4 = MV_IPv4 (MVector s IPv4)