Moduleserialise-0.2.6.1Haskell2010

Codec.Serialise.Decoding

High level API for decoding values that were encoded with the Codec.Serialise.Encoding module, using a Monad based interface.

3 types
40 values

Packageserialise-0.2.6.1
Exports43
LanguageHaskell2010
LicenceBSD-3-Clause
SourceDecoding.hs

Decode primitive operations

3 declarations

newtypenewtype Decoder s a

A continuation-based decoder, used for decoding values that were previously encoded using the Codec.CBOR.Encoding module. As Decoder has a Monad instance, you can easily write Decoders monadically for building your deserialisation logic.

Instances4Monad, Functor, MonadFail, Applicative

Monad (Decoder s)Defined in cborg-0.2.10.0 · Codec.CBOR.Decoding
Functor (Decoder s)Defined in cborg-0.2.10.0 · Codec.CBOR.Decoding
MonadFail (Decoder s)Defined in cborg-0.2.10.0 · Codec.CBOR.Decoding
Applicative (Decoder s)Defined in cborg-0.2.10.0 · Codec.CBOR.Decoding

datadata DecodeAction s a

An action, representing a step for a decoder to taken and a continuation to invoke with the expected value.

Constructors

ConsumeWord (Word# -> ST s (DecodeAction s a))
ConsumeWord8 (Word# -> ST s (DecodeAction s a))
ConsumeWord16 (Word# -> ST s (DecodeAction s a))
ConsumeWord32 (Word# -> ST s (DecodeAction s a))
ConsumeNegWord (Word# -> ST s (DecodeAction s a))
ConsumeInt (Int# -> ST s (DecodeAction s a))
ConsumeInt8 (Int# -> ST s (DecodeAction s a))
ConsumeInt16 (Int# -> ST s (DecodeAction s a))
ConsumeInt32 (Int# -> ST s (DecodeAction s a))
ConsumeListLen (Int# -> ST s (DecodeAction s a))
ConsumeMapLen (Int# -> ST s (DecodeAction s a))
ConsumeTag (Word# -> ST s (DecodeAction s a))
ConsumeInteger (Integer -> ST s (DecodeAction s a))
ConsumeFloat (Float# -> ST s (DecodeAction s a))
ConsumeDouble (Double# -> ST s (DecodeAction s a))
ConsumeBytes (ByteString -> ST s (DecodeAction s a))
ConsumeByteArray (ByteArray -> ST s (DecodeAction s a))
ConsumeString (Text -> ST s (DecodeAction s a))
ConsumeUtf8ByteArray (ByteArray -> ST s (DecodeAction s a))
ConsumeBool (Bool -> ST s (DecodeAction s a))
ConsumeSimple (Word# -> ST s (DecodeAction s a))
ConsumeBytesIndef (ST s (DecodeAction s a))
ConsumeStringIndef (ST s (DecodeAction s a))
ConsumeListLenIndef (ST s (DecodeAction s a))
ConsumeMapLenIndef (ST s (DecodeAction s a))
ConsumeNull (ST s (DecodeAction s a))
ConsumeListLenOrIndef (Int# -> ST s (DecodeAction s a))
ConsumeMapLenOrIndef (Int# -> ST s (DecodeAction s a))
ConsumeBreakOr (Bool -> ST s (DecodeAction s a))
PeekTokenType (TokenType -> ST s (DecodeAction s a))
PeekAvailable (Int# -> ST s (DecodeAction s a))
PeekByteOffset (Int# -> ST s (DecodeAction s a))
ConsumeWordCanonical (Word# -> ST s (DecodeAction s a))
ConsumeWord8Canonical (Word# -> ST s (DecodeAction s a))
ConsumeWord16Canonical (Word# -> ST s (DecodeAction s a))
ConsumeWord32Canonical (Word# -> ST s (DecodeAction s a))
ConsumeNegWordCanonical (Word# -> ST s (DecodeAction s a))
ConsumeIntCanonical (Int# -> ST s (DecodeAction s a))
ConsumeInt8Canonical (Int# -> ST s (DecodeAction s a))
ConsumeInt16Canonical (Int# -> ST s (DecodeAction s a))
ConsumeInt32Canonical (Int# -> ST s (DecodeAction s a))
ConsumeListLenCanonical (Int# -> ST s (DecodeAction s a))
ConsumeMapLenCanonical (Int# -> ST s (DecodeAction s a))
ConsumeTagCanonical (Word# -> ST s (DecodeAction s a))
ConsumeIntegerCanonical (Integer -> ST s (DecodeAction s a))
ConsumeFloat16Canonical (Float# -> ST s (DecodeAction s a))
ConsumeFloatCanonical (Float# -> ST s (DecodeAction s a))
ConsumeDoubleCanonical (Double# -> ST s (DecodeAction s a))
ConsumeBytesCanonical (ByteString -> ST s (DecodeAction s a))
ConsumeByteArrayCanonical (ByteArray -> ST s (DecodeAction s a))
ConsumeStringCanonical (Text -> ST s (DecodeAction s a))
ConsumeUtf8ByteArrayCanonical (ByteArray -> ST s (DecodeAction s a))
ConsumeSimpleCanonical (Word# -> ST s (DecodeAction s a))
Fail String
Done a

valuegetDecodeAction :: Decoder s a -> ST s (DecodeAction s a)

Given a Decoder, give us the DecodeAction

Read input tokens

valuedecodeWord :: Decoder s Word

Decode a Word.

valuedecodeWord8 :: Decoder s Word8

Decode a Word8.

valuedecodeWord16 :: Decoder s Word16

Decode a Word16.

valuedecodeWord32 :: Decoder s Word32

Decode a Word32.

valuedecodeWord64 :: Decoder s Word64

Decode a Word64.

valuedecodeNegWord :: Decoder s Word

Decode a negative Word.

valuedecodeNegWord64 :: Decoder s Word64

Decode a negative Word64.

valuedecodeInt :: Decoder s Int

Decode an Int.

valuedecodeInt8 :: Decoder s Int8

Decode an Int8.

valuedecodeInt16 :: Decoder s Int16

Decode an Int16.

valuedecodeInt32 :: Decoder s Int32

Decode an Int32.

valuedecodeInt64 :: Decoder s Int64

Decode an Int64.

valuedecodeInteger :: Decoder s Integer

Decode an Integer.

valuedecodeFloat :: Decoder s Float

Decode a Float.

valuedecodeDouble :: Decoder s Double

Decode a Double.

valuedecodeBytes :: Decoder s ByteString

Decode a string of bytes as a ByteString.

valuedecodeBytesIndef :: Decoder s ()

Decode a token marking the beginning of an indefinite length set of bytes.

valuedecodeByteArray :: Decoder s ByteArray

Decode a string of bytes as a ByteArray.

Also note that this will eagerly copy the content out of the input to ensure that the input does not leak in the event that the ByteArray is live but not forced.

valuedecodeString :: Decoder s Text

Decode a textual string as a piece of Text.

valuedecodeStringIndef :: Decoder s ()

Decode a token marking the beginning of an indefinite length string.

valuedecodeUtf8ByteArray :: Decoder s ByteArray

Decode a textual string as UTF-8 encoded ByteArray. Note that the result is not validated to be well-formed UTF-8.

Also note that this will eagerly copy the content out of the input to ensure that the input does not leak in the event that the ByteArray is live but not forced.

valuedecodeListLen :: Decoder s Int

Decode the length of a list.

valuedecodeListLenIndef :: Decoder s ()

Decode a token marking the beginning of a list of indefinite length.

valuedecodeMapLen :: Decoder s Int

Decode the length of a map.

valuedecodeMapLenIndef :: Decoder s ()

Decode a token marking the beginning of a map of indefinite length.

valuedecodeTag :: Decoder s Word

Decode an arbitrary tag and return it as a Word.

valuedecodeTag64 :: Decoder s Word64

Decode an arbitrary 64-bit tag and return it as a Word64.

valuedecodeBool :: Decoder s Bool

Decode a bool.

valuedecodeNull :: Decoder s ()

Decode a nullary value, and return a unit value.

valuedecodeSimple :: Decoder s Word8

Decode a simple CBOR value and give back a Word8. You probably don't ever need to use this.

Specialised Read input token operations

valuedecodeWordOf

:: Word
Expected value of the decoded word
-> Decoder s ()

Attempt to decode a word with decodeWord, and ensure the word is exactly as expected, or fail.

valuedecodeListLenOf :: Int -> Decoder s ()

Attempt to decode a list length using decodeListLen, and ensure it is exactly the specified length, or fail.

Branching operations

valuedecodeListLenOrIndef :: Decoder s (Maybe Int)

Attempt to decode a token for the length of a finite, known list, or an indefinite list. If Nothing is returned, then an indefinite length list occurs afterwords. If Just x is returned, then a list of length x is encoded.

valuedecodeMapLenOrIndef :: Decoder s (Maybe Int)

Attempt to decode a token for the length of a finite, known map, or an indefinite map. If Nothing is returned, then an indefinite length map occurs afterwords. If Just x is returned, then a map of length x is encoded.

valuedecodeBreakOr :: Decoder s Bool

Attempt to decode a Break token, and if that was successful, return True. If the token was of any other type, return False.

Inspecting the token type

valuepeekTokenType :: Decoder s TokenType

Peek at the current token we're about to decode, and return a TokenType specifying what it is.

valuepeekAvailable :: Decoder s Int

Peek and return the length of the current buffer that we're running our decoder on.

datadata TokenType

The type of a token, which a decoder can ask for at an arbitrary time.

Instances5Bounded, Enum, Eq, Ord, Show

Bounded TokenTypeDefined in cborg-0.2.10.0 · Codec.CBOR.Decoding
Enum TokenTypeDefined in cborg-0.2.10.0 · Codec.CBOR.Decoding
Eq TokenTypeDefined in cborg-0.2.10.0 · Codec.CBOR.Decoding
Ord TokenTypeDefined in cborg-0.2.10.0 · Codec.CBOR.Decoding
Show TokenTypeDefined in cborg-0.2.10.0 · Codec.CBOR.Decoding

Special operations

Sequence operations

2 declarations

valuedecodeSequenceLenIndef

:: r -> a -> r
-> r
-> r -> r'
-> Decoder s a
-> Decoder s r'

Decode an indefinite sequence length.

valuedecodeSequenceLenN

:: r -> a -> r
-> r
-> r -> r'
-> Int
-> Decoder s a
-> Decoder s r'

Decode a sequence length.