Data.Binary.ULEB128

Unsigned LEB128 codec.

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

Put

putNatural :: Natural -> Put

putWord64 :: Word64 -> Put

putWord32 :: Word32 -> Put

putWord16 :: Word16 -> Put

putWord8 :: Word8 -> Put

putWord :: Word -> Put

Get

getNatural

Arguments

:: Word

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

:: Word

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.