Data.Binary.ULEB128

Unsigned LEB128 codec. This codec encodes an unsigned number as described here.

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 Signed LEB128 codec at Data.Binary.SLEB128 nor with the ZigZag LEB128 codec at Data.Binary.ZLEB128.

Documentation

newtype ULEB128 x

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

Constructors

ULEB128 x

Instances

(DecodeOnly "getInt16" :: Constraint) => Binary (ULEB128 Int16)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Int16 -> Put

get :: Get (ULEB128 Int16)

putList :: [ULEB128 Int16] -> Put

(DecodeOnly "getInt32" :: Constraint) => Binary (ULEB128 Int32)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Int32 -> Put

get :: Get (ULEB128 Int32)

putList :: [ULEB128 Int32] -> Put

(DecodeOnly "getInt64" :: Constraint) => Binary (ULEB128 Int64)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Int64 -> Put

get :: Get (ULEB128 Int64)

putList :: [ULEB128 Int64] -> Put

(DecodeOnly "getInt8" :: Constraint) => Binary (ULEB128 Int8)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Int8 -> Put

get :: Get (ULEB128 Int8)

putList :: [ULEB128 Int8] -> Put

Binary (ULEB128 Word16)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Word16 -> Put

get :: Get (ULEB128 Word16)

putList :: [ULEB128 Word16] -> Put

Binary (ULEB128 Word32)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Word32 -> Put

get :: Get (ULEB128 Word32)

putList :: [ULEB128 Word32] -> Put

Binary (ULEB128 Word64)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Word64 -> Put

get :: Get (ULEB128 Word64)

putList :: [ULEB128 Word64] -> Put

Binary (ULEB128 Word8)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Word8 -> Put

get :: Get (ULEB128 Word8)

putList :: [ULEB128 Word8] -> Put

(DecodeOnly "getInteger" :: Constraint) => Binary (ULEB128 Integer)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Integer -> Put

get :: Get (ULEB128 Integer)

putList :: [ULEB128 Integer] -> Put

Binary (ULEB128 Natural)

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

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Natural -> Put

get :: Get (ULEB128 Natural)

putList :: [ULEB128 Natural] -> Put

(DecodeOnly "getInt" :: Constraint) => Binary (ULEB128 Int)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Int -> Put

get :: Get (ULEB128 Int)

putList :: [ULEB128 Int] -> Put

Binary (ULEB128 Word)

Defined in Data.Binary.ULEB128

Methods

put :: ULEB128 Word -> Put

get :: Get (ULEB128 Word)

putList :: [ULEB128 Word] -> Put

Put

putNatural :: Natural -> Put

putWord64 :: Word64 -> Put

putWord32 :: Word32 -> Put

putWord16 :: Word16 -> Put

putWord8 :: Word8 -> Put

putWord :: Word -> Put

Get

getNatural

Arguments

:: Int

Maximum number of bytes to consume. If the Natural 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

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

ByteString

putByteString :: ByteString -> Put

Puts a strict ByteString with its ULEB128-encoded length as prefix.

See getByteString.

getByteString :: Get ByteString

Gets a strict ByteString with its ULEB128-encoded length as prefix.

See putByteString.

Lazy

putLazyByteString :: ByteString -> Put

Puts a lazy ByteString with its ULEB128-encoded length as prefix.

See getLazyByteString.

getLazyByteString :: Get ByteString

Gets a lazy ByteString with its ULEB128-encoded length as prefix.

See putLazyByteString.

Short

putShortByteString :: ShortByteString -> Put

Puts a ShortByteString with its ULEB128-encoded length as prefix.

See getShortByteString.

getShortByteString :: Get ShortByteString

Gets a ShortByteString with its ULEB128-encoded length as prefix.

See putShortByteString.