Safe Haskell	None
Language	Haskell2010

Net.Types

Synopsis

Documentation

newtype IPv4 #

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 #
Methods minBound :: IPv4 # maxBound :: IPv4 #
Enum IPv4 #
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 #
Methods (==) :: IPv4 -> IPv4 -> Bool # (/=) :: IPv4 -> IPv4 -> Bool #
Ord IPv4 #
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 #
Methods readsPrec :: Int -> ReadS IPv4 # readList :: ReadS [IPv4] # readPrec :: ReadPrec IPv4 # readListPrec :: ReadPrec [IPv4] #
Show IPv4 #
Methods showsPrec :: Int -> IPv4 -> ShowS # show :: IPv4 -> String # showList :: [IPv4] -> ShowS #
Generic IPv4 #
Associated Types type Rep IPv4 :: * -> * # Methods from :: IPv4 -> Rep IPv4 x # to :: Rep IPv4 x -> IPv4 #
Hashable IPv4 #
Methods hashWithSalt :: Int -> IPv4 -> Int # hash :: IPv4 -> Int #
ToJSON IPv4 #
Methods toJSON :: IPv4 -> Value # toEncoding :: IPv4 -> Encoding # toJSONList :: [IPv4] -> Value # toEncodingList :: [IPv4] -> Encoding #
ToJSONKey IPv4 #
Methods toJSONKey :: ToJSONKeyFunction IPv4 # toJSONKeyList :: ToJSONKeyFunction [IPv4] #
FromJSON IPv4 #
Methods parseJSON :: Value -> Parser IPv4 # parseJSONList :: Value -> Parser [IPv4] #
FromJSONKey IPv4 #
Methods fromJSONKey :: FromJSONKeyFunction IPv4 # fromJSONKeyList :: FromJSONKeyFunction [IPv4] #
Storable IPv4 #
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 #
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 #
Methods finiteBitSize :: IPv4 -> Int # countLeadingZeros :: IPv4 -> Int # countTrailingZeros :: IPv4 -> Int #
Prim IPv4 #
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 #

Vector Vector IPv4 #
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 #
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 #
type Rep IPv4 = D1 * (MetaData "IPv4" "Net.IPv4" "ip-1.1.2-4XNKTBqMUo833F1xqbD8g" True) (C1 * (MetaCons "IPv4" PrefixI True) (S1 * (MetaSel (Just Symbol "getIPv4") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word32)))
data Vector IPv4 #
data Vector IPv4 = V_IPv4 (Vector IPv4)
data MVector s IPv4 #
data MVector s IPv4 = MV_IPv4 (MVector s IPv4)

data IPv6 #

A 128-bit Internet Protocol version 6 address.

Constructors

IPv6
Fields ipv6A :: !Word64 ipv6B :: !Word64

Instances

Eq IPv6 #
Methods (==) :: IPv6 -> IPv6 -> Bool # (/=) :: IPv6 -> IPv6 -> Bool #
Ord IPv6 #
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 #
Read IPv6 #
Methods readsPrec :: Int -> ReadS IPv6 # readList :: ReadS [IPv6] # readPrec :: ReadPrec IPv6 # readListPrec :: ReadPrec [IPv6] #
Show IPv6 #
Methods showsPrec :: Int -> IPv6 -> ShowS # show :: IPv6 -> String # showList :: [IPv6] -> ShowS #
ToJSON IPv6 #
Methods toJSON :: IPv6 -> Value # toEncoding :: IPv6 -> Encoding # toJSONList :: [IPv6] -> Value # toEncodingList :: [IPv6] -> Encoding #
FromJSON IPv6 #
Methods parseJSON :: Value -> Parser IPv6 # parseJSONList :: Value -> Parser [IPv6] #

newtype IP #

A 32-bit IPv4 address or a 128-bit IPv6 address. Internally, this is just represented as an IPv6 address. The functions provided in Net.IP help simulate constructing and pattern matching on values of this type. All functions and typeclass methods that convert IP values to text will display it as an IPv4 address if possible.

Constructors

IP
Fields getIP :: IPv6

Instances

Eq IP #
Methods (==) :: IP -> IP -> Bool # (/=) :: IP -> IP -> Bool #
Ord IP #
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 #
Read IP #
Methods readsPrec :: Int -> ReadS IP # readList :: ReadS [IP] # readPrec :: ReadPrec IP # readListPrec :: ReadPrec [IP] #
Show IP #
Methods showsPrec :: Int -> IP -> ShowS # show :: IP -> String # showList :: [IP] -> ShowS #
ToJSON IP #
Methods toJSON :: IP -> Value # toEncoding :: IP -> Encoding # toJSONList :: [IP] -> Value # toEncodingList :: [IP] -> Encoding #
FromJSON IP #
Methods parseJSON :: Value -> Parser IP # parseJSONList :: Value -> Parser [IP] #

data IPv4Range #

The length should be between 0 and 32. These bounds are inclusive. This expectation is not in any way enforced by this library because it does not cause errors. A mask length greater than 32 will be treated as if it were 32.

Constructors

IPv4Range
Fields ipv4RangeBase :: !IPv4 ipv4RangeLength :: !Word8

Instances

Eq IPv4Range #
Methods (==) :: IPv4Range -> IPv4Range -> Bool # (/=) :: IPv4Range -> IPv4Range -> Bool #
Ord IPv4Range #
Methods compare :: IPv4Range -> IPv4Range -> Ordering # (<) :: IPv4Range -> IPv4Range -> Bool # (<=) :: IPv4Range -> IPv4Range -> Bool # (>) :: IPv4Range -> IPv4Range -> Bool # (>=) :: IPv4Range -> IPv4Range -> Bool # max :: IPv4Range -> IPv4Range -> IPv4Range # min :: IPv4Range -> IPv4Range -> IPv4Range #
Read IPv4Range #
Methods readsPrec :: Int -> ReadS IPv4Range # readList :: ReadS [IPv4Range] # readPrec :: ReadPrec IPv4Range # readListPrec :: ReadPrec [IPv4Range] #
Show IPv4Range #
Methods showsPrec :: Int -> IPv4Range -> ShowS # show :: IPv4Range -> String # showList :: [IPv4Range] -> ShowS #
Generic IPv4Range #
Associated Types type Rep IPv4Range :: * -> * # Methods from :: IPv4Range -> Rep IPv4Range x # to :: Rep IPv4Range x -> IPv4Range #
Hashable IPv4Range #
Methods hashWithSalt :: Int -> IPv4Range -> Int # hash :: IPv4Range -> Int #
ToJSON IPv4Range #
Methods toJSON :: IPv4Range -> Value # toEncoding :: IPv4Range -> Encoding # toJSONList :: [IPv4Range] -> Value # toEncodingList :: [IPv4Range] -> Encoding #
FromJSON IPv4Range #
Methods parseJSON :: Value -> Parser IPv4Range # parseJSONList :: Value -> Parser [IPv4Range] #
Unbox IPv4Range #

Vector Vector IPv4Range #
Methods basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) IPv4Range -> m (Vector IPv4Range) # basicUnsafeThaw :: PrimMonad m => Vector IPv4Range -> m (Mutable Vector (PrimState m) IPv4Range) # basicLength :: Vector IPv4Range -> Int # basicUnsafeSlice :: Int -> Int -> Vector IPv4Range -> Vector IPv4Range # basicUnsafeIndexM :: Monad m => Vector IPv4Range -> Int -> m IPv4Range # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) IPv4Range -> Vector IPv4Range -> m () # elemseq :: Vector IPv4Range -> IPv4Range -> b -> b #
MVector MVector IPv4Range #
Methods basicLength :: MVector s IPv4Range -> Int # basicUnsafeSlice :: Int -> Int -> MVector s IPv4Range -> MVector s IPv4Range # basicOverlaps :: MVector s IPv4Range -> MVector s IPv4Range -> Bool # basicUnsafeNew :: PrimMonad m => Int -> m (MVector (PrimState m) IPv4Range) # basicInitialize :: PrimMonad m => MVector (PrimState m) IPv4Range -> m () # basicUnsafeReplicate :: PrimMonad m => Int -> IPv4Range -> m (MVector (PrimState m) IPv4Range) # basicUnsafeRead :: PrimMonad m => MVector (PrimState m) IPv4Range -> Int -> m IPv4Range # basicUnsafeWrite :: PrimMonad m => MVector (PrimState m) IPv4Range -> Int -> IPv4Range -> m () # basicClear :: PrimMonad m => MVector (PrimState m) IPv4Range -> m () # basicSet :: PrimMonad m => MVector (PrimState m) IPv4Range -> IPv4Range -> m () # basicUnsafeCopy :: PrimMonad m => MVector (PrimState m) IPv4Range -> MVector (PrimState m) IPv4Range -> m () # basicUnsafeMove :: PrimMonad m => MVector (PrimState m) IPv4Range -> MVector (PrimState m) IPv4Range -> m () # basicUnsafeGrow :: PrimMonad m => MVector (PrimState m) IPv4Range -> Int -> m (MVector (PrimState m) IPv4Range) #
type Rep IPv4Range #
type Rep IPv4Range = D1 * (MetaData "IPv4Range" "Net.IPv4.Range" "ip-1.1.2-4XNKTBqMUo833F1xqbD8g" False) (C1 * (MetaCons "IPv4Range" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "ipv4RangeBase") SourceUnpack SourceStrict DecidedStrict) (Rec0 * IPv4)) (S1 * (MetaSel (Just Symbol "ipv4RangeLength") SourceUnpack SourceStrict DecidedStrict) (Rec0 * Word8))))
data Vector IPv4Range #
data Vector IPv4Range = V_IPv4Range !(Vector IPv4) !(Vector Word8)
data MVector s IPv4Range #
data MVector s IPv4Range = MV_IPv4Range !(MVector s IPv4) !(MVector s Word8)

newtype Mac #

A 48-bit MAC address. Do not use the data constructor for this type. It is not considered part of the stable API, and it allows you to construct invalid MAC addresses.

Constructors

Mac Word64

Instances

Eq Mac #
Methods (==) :: Mac -> Mac -> Bool # (/=) :: Mac -> Mac -> Bool #
Ord Mac #
Methods compare :: Mac -> Mac -> Ordering # (<) :: Mac -> Mac -> Bool # (<=) :: Mac -> Mac -> Bool # (>) :: Mac -> Mac -> Bool # (>=) :: Mac -> Mac -> Bool # max :: Mac -> Mac -> Mac # min :: Mac -> Mac -> Mac #
Read Mac #
Methods readsPrec :: Int -> ReadS Mac # readList :: ReadS [Mac] # readPrec :: ReadPrec Mac # readListPrec :: ReadPrec [Mac] #
Show Mac #
Methods showsPrec :: Int -> Mac -> ShowS # show :: Mac -> String # showList :: [Mac] -> ShowS #
Generic Mac #
Associated Types type Rep Mac :: * -> * # Methods from :: Mac -> Rep Mac x # to :: Rep Mac x -> Mac #
Hashable Mac #
Methods hashWithSalt :: Int -> Mac -> Int # hash :: Mac -> Int #
ToJSON Mac #
Methods toJSON :: Mac -> Value # toEncoding :: Mac -> Encoding # toJSONList :: [Mac] -> Value # toEncodingList :: [Mac] -> Encoding #
ToJSONKey Mac #
Methods toJSONKey :: ToJSONKeyFunction Mac # toJSONKeyList :: ToJSONKeyFunction [Mac] #
FromJSON Mac #
Methods parseJSON :: Value -> Parser Mac # parseJSONList :: Value -> Parser [Mac] #
FromJSONKey Mac #
Methods fromJSONKey :: FromJSONKeyFunction Mac # fromJSONKeyList :: FromJSONKeyFunction [Mac] #
type Rep Mac #
type Rep Mac = D1 * (MetaData "Mac" "Net.Mac" "ip-1.1.2-4XNKTBqMUo833F1xqbD8g" True) (C1 * (MetaCons "Mac" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word64)))

data MacCodec #

Constructors

MacCodec
Fields macCodecGrouping :: !MacGrouping macCodecUpperCase :: !Bool

Instances

Eq MacCodec #
Methods (==) :: MacCodec -> MacCodec -> Bool # (/=) :: MacCodec -> MacCodec -> Bool #
Ord MacCodec #
Methods compare :: MacCodec -> MacCodec -> Ordering # (<) :: MacCodec -> MacCodec -> Bool # (<=) :: MacCodec -> MacCodec -> Bool # (>) :: MacCodec -> MacCodec -> Bool # (>=) :: MacCodec -> MacCodec -> Bool # max :: MacCodec -> MacCodec -> MacCodec # min :: MacCodec -> MacCodec -> MacCodec #
Read MacCodec #
Methods readsPrec :: Int -> ReadS MacCodec # readList :: ReadS [MacCodec] # readPrec :: ReadPrec MacCodec # readListPrec :: ReadPrec [MacCodec] #
Show MacCodec #
Methods showsPrec :: Int -> MacCodec -> ShowS # show :: MacCodec -> String # showList :: [MacCodec] -> ShowS #
Generic MacCodec #
Associated Types type Rep MacCodec :: * -> * # Methods from :: MacCodec -> Rep MacCodec x # to :: Rep MacCodec x -> MacCodec #
type Rep MacCodec #
type Rep MacCodec = D1 * (MetaData "MacCodec" "Net.Mac" "ip-1.1.2-4XNKTBqMUo833F1xqbD8g" False) (C1 * (MetaCons "MacCodec" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "macCodecGrouping") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * MacGrouping)) (S1 * (MetaSel (Just Symbol "macCodecUpperCase") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Bool))))

data MacGrouping #

The format expected by the mac address parser. The Word8 taken by some of these constructors is the ascii value of the character to be used as the separator. This is typically a colon, a hyphen, or a space character. All decoding functions are case insensitive.

Constructors

MacGroupingPairs !Char	Two-character groups, `FA:2B:40:09:8C:11`
MacGroupingTriples !Char	Three-character groups, `24B-F0A-025-829`
MacGroupingQuadruples !Char	Four-character groups, `A220.0745.CAC7`
MacGroupingNoSeparator	No separator, `24AF4B5B0780`

Instances

Eq MacGrouping #
Methods (==) :: MacGrouping -> MacGrouping -> Bool # (/=) :: MacGrouping -> MacGrouping -> Bool #
Ord MacGrouping #
Methods compare :: MacGrouping -> MacGrouping -> Ordering # (<) :: MacGrouping -> MacGrouping -> Bool # (<=) :: MacGrouping -> MacGrouping -> Bool # (>) :: MacGrouping -> MacGrouping -> Bool # (>=) :: MacGrouping -> MacGrouping -> Bool # max :: MacGrouping -> MacGrouping -> MacGrouping # min :: MacGrouping -> MacGrouping -> MacGrouping #
Read MacGrouping #
Methods readsPrec :: Int -> ReadS MacGrouping # readList :: ReadS [MacGrouping] # readPrec :: ReadPrec MacGrouping # readListPrec :: ReadPrec [MacGrouping] #
Show MacGrouping #
Methods showsPrec :: Int -> MacGrouping -> ShowS # show :: MacGrouping -> String # showList :: [MacGrouping] -> ShowS #
Generic MacGrouping #
Associated Types type Rep MacGrouping :: * -> * # Methods from :: MacGrouping -> Rep MacGrouping x # to :: Rep MacGrouping x -> MacGrouping #
type Rep MacGrouping #
type Rep MacGrouping = D1 * (MetaData "MacGrouping" "Net.Mac" "ip-1.1.2-4XNKTBqMUo833F1xqbD8g" False) ((:+:) * ((:+:) * (C1 * (MetaCons "MacGroupingPairs" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Char))) (C1 * (MetaCons "MacGroupingTriples" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Char)))) ((:+:) * (C1 * (MetaCons "MacGroupingQuadruples" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Char))) (C1 * (MetaCons "MacGroupingNoSeparator" PrefixI False) (U1 *))))