Safe Haskell	Safe-Inferred
Language	GHC2021

Data.Binary.ZLEB128

Contents

Put
Get

Description

ZigZag LEB128 codec. This codec encodes the ZigZag representation of a signed number through ULEB128.

Any getXXX decoder can decode bytes generated using any of the putXXX encoders, provided the encoded number fits in the target type.

WARNING: This is not compatible with the Unsigned LEB128 codec at Data.Binary.ULEB128 nor with the Signed LEB128 codec at Data.Binary.SLEB128.

Synopsis

Documentation

newtype ZLEB128 x Source #

Newtype wrapper for Binary encoding and decoding x using the ZigZag LEB128 codec. Useful in conjunction with DerivingVia.

Constructors

ZLEB128 x

Instances

Instances details

Binary (ZLEB128 Int16) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Int16 -> Put # get :: Get (ZLEB128 Int16) # putList :: [ZLEB128 Int16] -> Put #
Binary (ZLEB128 Int32) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Int32 -> Put # get :: Get (ZLEB128 Int32) # putList :: [ZLEB128 Int32] -> Put #
Binary (ZLEB128 Int64) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Int64 -> Put # get :: Get (ZLEB128 Int64) # putList :: [ZLEB128 Int64] -> Put #
Binary (ZLEB128 Int8) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Int8 -> Put # get :: Get (ZLEB128 Int8) # putList :: [ZLEB128 Int8] -> Put #
Binary (ZLEB128 Word16) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Word16 -> Put # get :: Get (ZLEB128 Word16) # putList :: [ZLEB128 Word16] -> Put #
Binary (ZLEB128 Word32) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Word32 -> Put # get :: Get (ZLEB128 Word32) # putList :: [ZLEB128 Word32] -> Put #
Binary (ZLEB128 Word64) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Word64 -> Put # get :: Get (ZLEB128 Word64) # putList :: [ZLEB128 Word64] -> Put #
Binary (ZLEB128 Word8) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Word8 -> Put # get :: Get (ZLEB128 Word8) # putList :: [ZLEB128 Word8] -> Put #
Binary (ZLEB128 Integer) Source #	Note: Maximum allowed number of input bytes is restricted to 1024. Use `putNatural` if you want a greater limit.
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Integer -> Put # get :: Get (ZLEB128 Integer) # putList :: [ZLEB128 Integer] -> Put #
Binary (ZLEB128 Natural) Source #	Note: Maximum allowed number of input bytes is restricted to 1024. Use `putNatural` if you want a greater limit.
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Natural -> Put # get :: Get (ZLEB128 Natural) # putList :: [ZLEB128 Natural] -> Put #
Binary (ZLEB128 Int) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Int -> Put # get :: Get (ZLEB128 Int) # putList :: [ZLEB128 Int] -> Put #
Binary (ZLEB128 Word) Source #
Instance details Defined in Data.Binary.ZLEB128 Methods put :: ZLEB128 Word -> Put # get :: Get (ZLEB128 Word) # putList :: [ZLEB128 Word] -> Put #

Put

putInteger :: Integer -> Put Source #

putInt64 :: Int64 -> Put Source #

putInt32 :: Int32 -> Put Source #

putInt16 :: Int16 -> Put Source #

putInt8 :: Int8 -> Put Source #

putInt :: Int -> Put Source #

putNatural :: Natural -> Put Source #

putWord64 :: Word64 -> Put Source #

putWord32 :: Word32 -> Put Source #

putWord16 :: Word16 -> Put Source #

putWord8 :: Word8 -> Put Source #

putWord :: Word -> Put Source #

Get

getInteger Source #

Arguments

:: Int

Maximum number of bytes to consume. If the Integer number can be determined before consuming this number of bytes, it will be. If 0, parsing fails.

Each ULEB128 byte encodes at most 7 bits of data. That is, \(length(encoded) == \lceil\frac{length(data)}{7}\rceil\).

-> Get Integer

getInt64 :: Get Int64 Source #

getInt32 :: Get Int32 Source #

getInt16 :: Get Int16 Source #

getInt8 :: Get Int8 Source #

getInt :: Get Int Source #

getNatural Source #

Arguments

:: Int

Maximum number of bytes to consume. If the Integer number can be determined before consuming this number of bytes, it will be. If 0, parsing fails.

Each ULEB128 byte encodes at most 7 bits of data. That is, \(length(encoded) == \lceil\frac{length(data)}{7}\rceil\).

-> Get Natural

getWord64 :: Get Word64 Source #

getWord32 :: Get Word32 Source #

getWord16 :: Get Word16 Source #

getWord8 :: Get Word8 Source #

getWord :: Get Word Source #