Data.Binary.SLEB128

Signed LEB128 codec. This codec encodes the two's complement of a signed 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 Unsigned LEB128 codec at Data.Binary.ULEB128 nor with the ZigZag LEB128 codec at Data.Binary.ZLEB128.

Documentation

newtype SLEB128 x

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

Constructors

SLEB128 x

Instances

Binary (SLEB128 Int16)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Int16 -> Put

get :: Get (SLEB128 Int16)

putList :: [SLEB128 Int16] -> Put

Binary (SLEB128 Int32)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Int32 -> Put

get :: Get (SLEB128 Int32)

putList :: [SLEB128 Int32] -> Put

Binary (SLEB128 Int64)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Int64 -> Put

get :: Get (SLEB128 Int64)

putList :: [SLEB128 Int64] -> Put

Binary (SLEB128 Int8)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Int8 -> Put

get :: Get (SLEB128 Int8)

putList :: [SLEB128 Int8] -> Put

Binary (SLEB128 Word16)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Word16 -> Put

get :: Get (SLEB128 Word16)

putList :: [SLEB128 Word16] -> Put

Binary (SLEB128 Word32)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Word32 -> Put

get :: Get (SLEB128 Word32)

putList :: [SLEB128 Word32] -> Put

Binary (SLEB128 Word64)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Word64 -> Put

get :: Get (SLEB128 Word64)

putList :: [SLEB128 Word64] -> Put

Binary (SLEB128 Word8)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Word8 -> Put

get :: Get (SLEB128 Word8)

putList :: [SLEB128 Word8] -> Put

Binary (SLEB128 Integer)

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

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Integer -> Put

get :: Get (SLEB128 Integer)

putList :: [SLEB128 Integer] -> Put

Binary (SLEB128 Natural)

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

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Natural -> Put

get :: Get (SLEB128 Natural)

putList :: [SLEB128 Natural] -> Put

Binary (SLEB128 Int)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Int -> Put

get :: Get (SLEB128 Int)

putList :: [SLEB128 Int] -> Put

Binary (SLEB128 Word)

Defined in Data.Binary.SLEB128

Methods

put :: SLEB128 Word -> Put

get :: Get (SLEB128 Word)

putList :: [SLEB128 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 SLEB128 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 Natural number can be determined before consuming this number of bytes, it will be. If 0, parsing fails.

Each SLEB128 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

Extras

Scientific

putScientific :: Scientific -> Put

Compact Scientific encoding. Internally, it uses both ULEB128 and SLEB128. 0 is encoded as \x00, other numbers take at least two bytes.

Compatible decoders are getFixed and getScientific.

getScientific

Arguments

:: Int

Maximum number of ULEB128 bytes to consume for the coefficient part. See getNatural.

-> Get Scientific

Decode a Scientific encoded with putScientific or putFixed.

Rational

putRational :: Rational -> Put

Compact Rational encoding. Internally, it uses both ULEB128 and SLEB128. Decode with getRational. 0 is encoded as \x00, other numbers take at least four bytes.

getRational

Arguments

:: Int

Maximum number of bytes to consume for each of the numerator and denominator parts. See getNatural.

-> Get Rational

Decode a Rational encoded with putRational.

Fixed

putFixed :: HasResolution r => Fixed r -> Put

Same encoding as putScientific.

Compatible decoders are getFixed and getScientific.

getFixed

Arguments

:: HasResolution r

=> Int

Maximum number of ULEB128 bytes to consume for the coefficient part. See getNatural.

-> Get (Fixed r)

Decode a Fixed encoded with putFixed or putScientific.