Data.Binary.ZLEB128

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.

Documentation

newtype ZLEB128 x

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

Constructors

ZLEB128 x

Instances

Binary (ZLEB128 Int16)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Int16 -> Put

get :: Get (ZLEB128 Int16)

putList :: [ZLEB128 Int16] -> Put

Binary (ZLEB128 Int32)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Int32 -> Put

get :: Get (ZLEB128 Int32)

putList :: [ZLEB128 Int32] -> Put

Binary (ZLEB128 Int64)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Int64 -> Put

get :: Get (ZLEB128 Int64)

putList :: [ZLEB128 Int64] -> Put

Binary (ZLEB128 Int8)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Int8 -> Put

get :: Get (ZLEB128 Int8)

putList :: [ZLEB128 Int8] -> Put

Binary (ZLEB128 Word16)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Word16 -> Put

get :: Get (ZLEB128 Word16)

putList :: [ZLEB128 Word16] -> Put

Binary (ZLEB128 Word32)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Word32 -> Put

get :: Get (ZLEB128 Word32)

putList :: [ZLEB128 Word32] -> Put

Binary (ZLEB128 Word64)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Word64 -> Put

get :: Get (ZLEB128 Word64)

putList :: [ZLEB128 Word64] -> Put

Binary (ZLEB128 Word8)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Word8 -> Put

get :: Get (ZLEB128 Word8)

putList :: [ZLEB128 Word8] -> Put

Binary (ZLEB128 Integer)

Note: Maximum allowed number of input bytes is restricted to 1024. Use putNatural if you want a greater limit.

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Integer -> Put

get :: Get (ZLEB128 Integer)

putList :: [ZLEB128 Integer] -> Put

Binary (ZLEB128 Natural)

Note: Maximum allowed number of input bytes is restricted to 1024. Use putNatural if you want a greater limit.

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Natural -> Put

get :: Get (ZLEB128 Natural)

putList :: [ZLEB128 Natural] -> Put

Binary (ZLEB128 Int)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Int -> Put

get :: Get (ZLEB128 Int)

putList :: [ZLEB128 Int] -> Put

Binary (ZLEB128 Word)

Defined in Data.Binary.ZLEB128

Methods

put :: ZLEB128 Word -> Put

get :: Get (ZLEB128 Word)

putList :: [ZLEB128 Word] -> Put

Put

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

Get

getInteger

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

getInt32 :: Get Int32

getInt16 :: Get Int16

getInt8 :: Get Int8

getInt :: Get Int

getNatural

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

getWord32 :: Get Word32

getWord16 :: Get Word16

getWord8 :: Get Word8

getWord :: Get Word