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


-- | Signed and unsigned LEB128 codec for binary library
--   
--   Signed and unsigned LEB128 codec for <tt>binary</tt> library.
@package leb128-binary
@version 0.1.3


-- | <b>Unsigned LEB128 codec</b>. This codec encodes an unsigned number
--   <a>as described here</a>.
--   
--   Any <i>getXXX</i> decoder can decode bytes generated using any of the
--   <i>putXXX</i> encoders, provided the encoded number fits in the target
--   type.
--   
--   <b>WARNING</b>: This is not compatible with the <i>Signed LEB128</i>
--   codec at <a>Data.Binary.SLEB128</a> nor with the <i>ZigZag LEB128</i>
--   codec at <a>Data.Binary.ZLEB128</a>.
module Data.Binary.ULEB128

-- | Newtype wrapper for <a>Binary</a> encoding and decoding <tt>x</tt>
--   using the <i>Unsigned LEB128</i> codec. Useful in conjunction with
--   <tt>DerivingVia</tt>.
newtype ULEB128 x
ULEB128 :: x -> ULEB128 x
putNatural :: Natural -> Put
putWord64 :: Word64 -> Put
putWord32 :: Word32 -> Put
putWord16 :: Word16 -> Put
putWord8 :: Word8 -> Put
putWord :: Word -> Put
getNatural :: Int -> Get Natural
getWord64 :: Get Word64
getWord32 :: Get Word32
getWord16 :: Get Word16
getWord8 :: Get Word8
getWord :: Get Word
getInteger :: Int -> Get Integer
getInt64 :: Get Int64
getInt32 :: Get Int32
getInt16 :: Get Int16
getInt8 :: Get Int8
getInt :: Get Int

-- | Puts a strict <a>ByteString</a> with its ULEB128-encoded length as
--   prefix.
--   
--   See <a>getByteString</a>.
putByteString :: ByteString -> Put

-- | Gets a strict <a>ByteString</a> with its ULEB128-encoded length as
--   prefix.
--   
--   See <a>putByteString</a>.
getByteString :: Get ByteString

-- | Puts a lazy <a>ByteString</a> with its ULEB128-encoded length as
--   prefix.
--   
--   See <a>getLazyByteString</a>.
putLazyByteString :: ByteString -> Put

-- | Gets a lazy <a>ByteString</a> with its ULEB128-encoded length as
--   prefix.
--   
--   See <a>putLazyByteString</a>.
getLazyByteString :: Get ByteString

-- | Puts a <a>ShortByteString</a> with its ULEB128-encoded length as
--   prefix.
--   
--   See <a>getShortByteString</a>.
putShortByteString :: ShortByteString -> Put

-- | Gets a <a>ShortByteString</a> with its ULEB128-encoded length as
--   prefix.
--   
--   See <a>putShortByteString</a>.
getShortByteString :: Get ShortByteString

-- | Puts a strict <a>Text</a>, UTF8-encoded with its ULEB128-encoded
--   length as prefix.
--   
--   See <a>getText</a>.
putText :: Text -> Put

-- | Gets a strict <a>Text</a>, UTF8-encoded with its ULEB128-encoded
--   length as prefix.
--   
--   See <a>putText</a>.
getText :: Get Text

-- | Puts a lazy <a>Text</a>, UTF8-encoded with its ULEB128-encoded length
--   as prefix.
--   
--   See <a>getLazyText</a>.
putLazyText :: Text -> Put

-- | Gets a lazy <a>Text</a>, UTF8-encoded with its ULEB128-encoded length
--   as prefix.
--   
--   See <a>putLazyText</a>.
getLazyText :: Get Text

-- | Elements of the list are prefixed with ULEB128-encoded length. Decode
--   with <a>getList</a>.
putList :: (a -> Put) -> [a] -> Put

-- | Decodes a list encoded with <a>putList</a>.
getList :: forall a. Get a -> Get [a]

-- | Elements of the <a>Seq</a> are prefixed with ULEB128-encoded length.
--   Decode with <a>getSeq</a>.
putSeq :: (a -> Put) -> Seq a -> Put

-- | Decodes a list encoded with <a>putSeq</a>.
getSeq :: forall a. Get a -> Get (Seq a)

-- | Elements of the <a>Set</a> are prefixed with ULEB128-encoded length.
--   Decode with <a>getSet</a>.
putSet :: (a -> Put) -> Set a -> Put

-- | Decodes a list encoded with <a>putSet</a>.
getSet :: forall a. Ord a => Get a -> Get (Set a)

-- | Elements of the <a>Map</a> are prefixed with ULEB128-encoded length.
--   Decode with <a>getMap</a>.
putMap :: (k -> Put) -> (v -> Put) -> Map k v -> Put

-- | Decodes a list encoded with <a>putMap</a>.
getMap :: forall k v. Ord k => Get k -> Get v -> Get (Map k v)
instance Data.Binary.ULEB128.DecodeOnly "getInt8" => Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Int.Int8)
instance Data.Binary.ULEB128.DecodeOnly "getInt16" => Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Int.Int16)
instance Data.Binary.ULEB128.DecodeOnly "getInt32" => Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Int.Int32)
instance Data.Binary.ULEB128.DecodeOnly "getInt64" => Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Int.Int64)
instance Data.Binary.ULEB128.DecodeOnly "getInt" => Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Types.Int)
instance Data.Binary.ULEB128.DecodeOnly "getInteger" => Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Num.Integer.Integer)
instance Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Num.Natural.Natural)
instance Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Types.Word)
instance Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Word.Word8)
instance Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Word.Word16)
instance Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Word.Word32)
instance Data.Binary.Class.Binary (Data.Binary.ULEB128.ULEB128 GHC.Word.Word64)


-- | <b>Signed LEB128 codec</b>. This codec encodes the two's complement of
--   a signed number <a>as described here</a>.
--   
--   Any <i>getXXX</i> decoder can decode bytes generated using any of the
--   <i>putXXX</i> encoders, provided the encoded number fits in the target
--   type.
--   
--   <b>WARNING</b>: This is not compatible with the <i>Unsigned LEB128</i>
--   codec at <a>Data.Binary.ULEB128</a> nor with the <i>ZigZag LEB128</i>
--   codec at <a>Data.Binary.ZLEB128</a>.
module Data.Binary.SLEB128

-- | Newtype wrapper for <a>Binary</a> encoding and decoding <tt>x</tt>
--   using the <i>Signed LEB128</i> codec. Useful in conjunction with
--   <tt>DerivingVia</tt>.
newtype SLEB128 x
SLEB128 :: x -> SLEB128 x
putInteger :: Integer -> Put
putInt64 :: Int64 -> Put
putInt32 :: Int32 -> Put
putInt16 :: Int16 -> Put
putInt8 :: Int8 -> Put
putInt :: Int -> Put
putNatural :: Natural -> Put
putWord64 :: Word64 -> Put
putWord32 :: Word32 -> Put
putWord16 :: Word16 -> Put
putWord8 :: Word8 -> Put
putWord :: Word -> Put
getInteger :: Int -> Get Integer
getInt64 :: Get Int64
getInt32 :: Get Int32
getInt16 :: Get Int16
getInt8 :: Get Int8
getInt :: Get Int
getNatural :: Int -> Get Natural
getWord64 :: Get Word64
getWord32 :: Get Word32
getWord16 :: Get Word16
getWord8 :: Get Word8
getWord :: Get Word

-- | Compact <a>Scientific</a> encoding. Internally, it uses both ULEB128
--   and SLEB128. 0 is encoded as <tt>\x00</tt>, other numbers take at
--   least two bytes.
--   
--   Compatible decoders are <a>getFixed</a> and <a>getScientific</a>.
putScientific :: Scientific -> Put

-- | Decode a <a>Scientific</a> encoded with <a>putScientific</a> or
--   <a>putFixed</a>.
getScientific :: Int -> Get Scientific

-- | Compact <a>Rational</a> encoding. Internally, it uses both ULEB128 and
--   SLEB128. Decode with <a>getRational</a>. 0 is encoded as
--   <tt>\x00</tt>, other numbers take at least four bytes.
putRational :: Rational -> Put

-- | Decode a <a>Rational</a> encoded with <a>putRational</a>.
getRational :: Int -> Get Rational

-- | Same encoding as <a>putScientific</a>.
--   
--   Compatible decoders are <a>getFixed</a> and <a>getScientific</a>.
putFixed :: HasResolution r => Fixed r -> Put

-- | Decode a <a>Fixed</a> encoded with <a>putFixed</a> or
--   <a>putScientific</a>.
getFixed :: HasResolution r => Int -> Get (Fixed r)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Num.Integer.Integer)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Num.Natural.Natural)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Types.Int)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Types.Word)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Int.Int8)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Word.Word8)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Int.Int16)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Word.Word16)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Int.Int32)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Word.Word32)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Int.Int64)
instance Data.Binary.Class.Binary (Data.Binary.SLEB128.SLEB128 GHC.Word.Word64)


-- | <b>ZigZag LEB128 codec</b>. This codec encodes the <a>ZigZag</a>
--   representation of a signed number through <a>ULEB128</a>.
--   
--   Any <i>getXXX</i> decoder can decode bytes generated using any of the
--   <i>putXXX</i> encoders, provided the encoded number fits in the target
--   type.
--   
--   <b>WARNING</b>: This is not compatible with the <i>Unsigned LEB128</i>
--   codec at <a>Data.Binary.ULEB128</a> nor with the <i>Signed LEB128</i>
--   codec at <a>Data.Binary.SLEB128</a>.
module Data.Binary.ZLEB128

-- | Newtype wrapper for <a>Binary</a> encoding and decoding <tt>x</tt>
--   using the <i>ZigZag LEB128</i> codec. Useful in conjunction with
--   <tt>DerivingVia</tt>.
newtype ZLEB128 x
ZLEB128 :: x -> ZLEB128 x
putInteger :: Integer -> Put
putInt64 :: Int64 -> Put
putInt32 :: Int32 -> Put
putInt16 :: Int16 -> Put
putInt8 :: Int8 -> Put
putInt :: Int -> Put
putNatural :: Natural -> Put
putWord64 :: Word64 -> Put
putWord32 :: Word32 -> Put
putWord16 :: Word16 -> Put
putWord8 :: Word8 -> Put
putWord :: Word -> Put
getInteger :: Int -> Get Integer
getInt64 :: Get Int64
getInt32 :: Get Int32
getInt16 :: Get Int16
getInt8 :: Get Int8
getInt :: Get Int
getNatural :: Int -> Get Natural
getWord64 :: Get Word64
getWord32 :: Get Word32
getWord16 :: Get Word16
getWord8 :: Get Word8
getWord :: Get Word
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Num.Integer.Integer)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Num.Natural.Natural)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Types.Int)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Types.Word)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Int.Int8)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Word.Word8)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Int.Int16)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Word.Word16)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Int.Int32)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Word.Word32)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Int.Int64)
instance Data.Binary.Class.Binary (Data.Binary.ZLEB128.ZLEB128 GHC.Word.Word64)