-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Library for IP and MAC addresses
--   
--   Please see README.md
@package ip
@version 0.7

module Net.Internal
attoparsecParseJSON :: Parser a -> Value -> Parser a
rightToMaybe :: Either a b -> Maybe b


-- | 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 <tt>Net.IPv4.Text</tt> and
--   <tt>Net.IPv4.ByteString.Char8</tt> instead. They are defined here so
--   that the <a>FromJSON</a> and <a>ToJSON</a> 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 <tt>aeson</tt>'s new
--   <tt>toEncoding</tt> method.
module Net.IPv4

-- | A 32-bit Internet Protocol address.
newtype IPv4
IPv4 :: Word32 -> IPv4
[getIPv4] :: IPv4 -> Word32

-- | 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.
data IPv4Range
IPv4Range :: {-# UNPACK #-} !IPv4 -> {-# UNPACK #-} !Word8 -> IPv4Range
[ipv4RangeBase] :: IPv4Range -> {-# UNPACK #-} !IPv4
[ipv4RangeLength] :: IPv4Range -> {-# UNPACK #-} !Word8
mask :: Word8 -> Word32

-- | Normalize an <a>IPv4Range</a>. The first result of this is that the
--   <a>IPv4</a> inside the <a>IPv4Range</a> is changed so that the
--   insignificant bits are zeroed out. For example:
--   
--   <pre>
--   &gt;&gt;&gt; prRange $ normalize $ IPv4Range (fromOctets 192 168 1 19) 24
--   192.168.1.0/24
--   
--   &gt;&gt;&gt; prRange $ normalize $ IPv4Range (fromOctets 192 168 1 163) 28
--   192.168.1.160/28
--   </pre>
--   
--   The second effect of this is that the mask length is lowered to be 32
--   or smaller. Working with <a>IPv4Range</a>s that have not been
--   normalized does not cause any issues for this library, although other
--   applications may reject such ranges (especially those with a mask
--   length above 32).
--   
--   Note that <a>normalize</a> is idempotent, that is:
--   
--   <pre>
--   normalize r == (normalize . normalize) r
--   </pre>
normalize :: IPv4Range -> IPv4Range

-- | This is provided to mirror the interface provided by
--   <tt>Data.Set</tt>. It behaves just like <a>contains</a> but with
--   flipped arguments.
--   
--   <pre>
--   member ip r == contains r ip
--   </pre>
member :: IPv4 -> IPv4Range -> Bool
lowerInclusive :: IPv4Range -> IPv4
upperInclusive :: IPv4Range -> IPv4

-- | The RFC1918 24-bit block. Subnet mask: <tt>10.0.0.0/8</tt>
private24 :: IPv4Range

-- | The RFC1918 20-bit block. Subnet mask: <tt>172.16.0.0/12</tt>
private20 :: IPv4Range

-- | The RFC1918 16-bit block. Subnet mask: <tt>192.168.0.0/16</tt>
private16 :: IPv4Range

-- | Create an <a>IPv4</a> address from four octets. The first argument is
--   the most significant octet. The last argument is the least
--   significant.
--   
--   Since the <a>Show</a> and <a>Read</a> instances for <a>IPv4</a> are
--   not generally usefully, this function is the recommened way to create
--   <a>IPv4</a> addresses. For example:
--   
--   <pre>
--   &gt;&gt;&gt; fromOctets 192 168 1 1
--   IPv4 {getIPv4 = 3232235777}
--   </pre>
fromOctets :: Word8 -> Word8 -> Word8 -> Word8 -> IPv4

-- | This is sort of a misnomer. It takes Word32 to make dotDecimalParser
--   probably perform better. This is mostly for internal use.
fromOctets' :: Word32 -> Word32 -> Word32 -> Word32 -> IPv4

-- | Convert an <a>IPv4</a> 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.
toOctets :: IPv4 -> (Word8, Word8, Word8, Word8)

-- | $internal Everything below here is not part of the stable API. Many of
--   these functions must live here because they are needed for the
--   <a>ToJSON</a> and <a>FromJSON</a> instances. Hopefully, at some point,
--   these can be removed from this module.
--   
--   This only exists for doctests. Do not use it.
prAddr :: IPv4 -> IO ()

-- | This only exists for doctests. Do not use it.
prRange :: IPv4Range -> IO ()
fromDotDecimalText :: Text -> Maybe IPv4
fromDotDecimalText' :: Text -> Either String IPv4
rangeFromDotDecimalText' :: Text -> Either String IPv4Range
dotDecimalRangeParser :: Parser IPv4Range

-- | This does not do an endOfInput check because it is reused in the range
--   parser implementation.
dotDecimalParser :: Parser IPv4
toDotDecimalText :: IPv4 -> Text
toDotDecimalBuilder :: IPv4 -> Builder
rangeToDotDecimalText :: IPv4Range -> Text
rangeToDotDecimalBuilder :: IPv4Range -> Builder
instance GHC.Generics.Generic Net.IPv4.IPv4Range
instance GHC.Read.Read Net.IPv4.IPv4Range
instance GHC.Show.Show Net.IPv4.IPv4Range
instance GHC.Classes.Ord Net.IPv4.IPv4Range
instance GHC.Classes.Eq Net.IPv4.IPv4Range
instance GHC.Generics.Generic Net.IPv4.IPv4
instance Data.Hashable.Class.Hashable Net.IPv4.IPv4
instance GHC.Enum.Bounded Net.IPv4.IPv4
instance GHC.Enum.Enum Net.IPv4.IPv4
instance GHC.Read.Read Net.IPv4.IPv4
instance GHC.Show.Show Net.IPv4.IPv4
instance GHC.Classes.Ord Net.IPv4.IPv4
instance GHC.Classes.Eq Net.IPv4.IPv4
instance Data.Hashable.Class.Hashable Net.IPv4.IPv4Range
instance Data.Aeson.Types.Class.ToJSON Net.IPv4.IPv4
instance Data.Aeson.Types.Class.FromJSON Net.IPv4.IPv4
instance Data.Aeson.Types.Class.ToJSON Net.IPv4.IPv4Range
instance Data.Aeson.Types.Class.FromJSON Net.IPv4.IPv4Range
instance Data.Vector.Generic.Mutable.Base.MVector Data.Vector.Unboxed.Base.MVector Net.IPv4.IPv4

module Net.IPv4.Text
encode :: IPv4 -> Text
decode :: Text -> Maybe IPv4
decodeEither :: Text -> Either String IPv4
builder :: IPv4 -> Builder
parser :: Parser IPv4


-- | This module exists for the convenience of those who need a
--   <a>String</a> representation of an <a>IPv4</a> address. Using this
--   module is discouraged unless the end user is working with a library
--   that can only use <a>String</a> to deal with textual data (such as
--   <tt>pandoc</tt> or <tt>hxr</tt>).
module Net.IPv4.String
encode :: IPv4 -> String
decode :: String -> Maybe IPv4
decodeEither :: String -> Either String IPv4

module Net.IPv4.ByteString.Char8

-- | This should be rewritten to not create <tt>Text</tt> as an
--   intermediate step.
encode :: IPv4 -> ByteString

-- | This should also be rewritten
decode :: ByteString -> Maybe IPv4
builder :: IPv4 -> Builder
parser :: Parser IPv4

module Net.Mac
data Mac
Mac :: {-# UNPACK #-} !Word16 -> {-# UNPACK #-} !Word32 -> Mac
[macA] :: Mac -> {-# UNPACK #-} !Word16
[macB] :: Mac -> {-# UNPACK #-} !Word32
toText :: Mac -> Text
fromText :: Text -> Maybe Mac
fromText' :: Text -> Either String Mac
toTextBuilder :: Mac -> Builder

-- | This does not do an endOfInput check
textParser :: Parser Mac
bytestringParser :: Parser Mac
fromOctets :: Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Mac
fromOctets' :: Word16 -> Word16 -> Word32 -> Word32 -> Word32 -> Word32 -> Mac
instance GHC.Generics.Generic Net.Mac.Mac
instance GHC.Read.Read Net.Mac.Mac
instance GHC.Show.Show Net.Mac.Mac
instance GHC.Classes.Ord Net.Mac.Mac
instance GHC.Classes.Eq Net.Mac.Mac
instance Data.Hashable.Class.Hashable Net.Mac.Mac
instance Data.Aeson.Types.Class.ToJSON Net.Mac.Mac
instance Data.Aeson.Types.Class.FromJSON Net.Mac.Mac

module Net.Mac.Text
encode :: Mac -> Text
decode :: Text -> Maybe Mac
decodeEither :: Text -> Either String Mac
builder :: Mac -> Builder
parser :: Parser Mac

module Net.Mac.ByteString.Char8

-- | This is a bad implementation that should be rewritten
encode :: Mac -> ByteString

-- | This is a bad implementation that should be rewritten
decode :: ByteString -> Maybe Mac
builder :: Mac -> Builder
parser :: Parser Mac