serialise-0.1.0.0: A binary serialisation library for Haskell values.

Copyright(c) Duncan Coutts 2015-2017
LicenseBSD3-style (see LICENSE.txt)
Maintainerduncan@community.haskell.org
Stabilityexperimental
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe
LanguageHaskell2010

Codec.Serialise.Encoding

Contents

Description

High level API for encoding values, for later serialization into CBOR binary format, using a Monoid based interface.

Synopsis

Encoding implementation

newtype Encoding :: * #

An intermediate form used during serialisation, specified as a Monoid. It supports efficient concatenation, and is equivalent to a specialised Endo Tokens type.

It is used for the stage in serialisation where we flatten out the Haskell data structure but it is independent of any specific external binary or text format.

Traditionally, to build any arbitrary Encoding value, you specify larger structures from smaller ones and append the small ones together using mconcat.

Since: 0.2.0.0

Constructors

Encoding (Tokens -> Tokens) 

Instances

data Tokens :: * #

A flattened representation of a term, which is independent of any underlying binary representation, but which we later serialise into CBOR format.

Since: 0.2.0.0

Constructors

TkWord !Word Tokens 
TkWord64 !Word64 Tokens 
TkInt !Int Tokens 
TkInt64 !Int64 Tokens 
TkBytes !ByteString Tokens 
TkBytesBegin Tokens 
TkString !Text Tokens 
TkStringBegin Tokens 
TkListLen !Word Tokens 
TkListBegin Tokens 
TkMapLen !Word Tokens 
TkMapBegin Tokens 
TkTag !Word Tokens 
TkTag64 !Word64 Tokens 
TkInteger !Integer Tokens 
TkNull Tokens 
TkUndef Tokens 
TkBool !Bool Tokens 
TkSimple !Word8 Tokens 
TkFloat16 !Float Tokens 
TkFloat32 !Float Tokens 
TkFloat64 !Double Tokens 
TkBreak Tokens 
TkEnd 

Instances

Eq Tokens 

Methods

(==) :: Tokens -> Tokens -> Bool #

(/=) :: Tokens -> Tokens -> Bool #

Show Tokens 

Encoding API for serialisation

encodeWord :: Word -> Encoding #

Encode a Word in a flattened format.

Since: 0.2.0.0

encodeWord8 :: Word8 -> Encoding #

Encode a Word8 in a flattened format.

Since: 0.2.0.0

encodeWord16 :: Word16 -> Encoding #

Encode a Word16 in a flattened format.

Since: 0.2.0.0

encodeWord32 :: Word32 -> Encoding #

Encode a Word32 in a flattened format.

Since: 0.2.0.0

encodeWord64 :: Word64 -> Encoding #

Encode a Word64 in a flattened format.

Since: 0.2.0.0

encodeInt :: Int -> Encoding #

Encode an Int in a flattened format.

Since: 0.2.0.0

encodeInt8 :: Int8 -> Encoding #

Encode an Int8 in a flattened format.

Since: 0.2.0.0

encodeInt16 :: Int16 -> Encoding #

Encode an Int16 in a flattened format.

Since: 0.2.0.0

encodeInt32 :: Int32 -> Encoding #

Encode an Int32 in a flattened format.

Since: 0.2.0.0

encodeInt64 :: Int64 -> Encoding #

Encode an @Int64 in a flattened format.

Since: 0.2.0.0

encodeInteger :: Integer -> Encoding #

Encode an arbitrarily large @Integer in a flattened format.

Since: 0.2.0.0

encodeBytes :: ByteString -> Encoding #

Encode an arbitrary strict ByteString in a flattened format.

Since: 0.2.0.0

encodeBytesIndef :: Encoding #

Encode a token specifying the beginning of a string of bytes of indefinite length. In reality, this specifies a stream of many occurrences of encodeBytes, each specifying a single chunk of the overall string. After all the bytes desired have been encoded, you should follow it with a break token (see encodeBreak).

Since: 0.2.0.0

encodeString :: Text -> Encoding #

Encode a Text in a flattened format.

Since: 0.2.0.0

encodeStringIndef :: Encoding #

Encode the beginning of an indefinite string.

Since: 0.2.0.0

encodeListLen :: Word -> Encoding #

Encode the length of a list, used to indicate that the following tokens represent the list values.

Since: 0.2.0.0

encodeListLenIndef :: Encoding #

Encode a token specifying that this is the beginning of an indefinite list of unknown size. Tokens representing the list are expected afterwords, followed by a break token (see encodeBreak) when the list has ended.

Since: 0.2.0.0

encodeMapLen :: Word -> Encoding #

Encode the length of a Map, used to indicate that the following tokens represent the map values.

Since: 0.2.0.0

encodeMapLenIndef :: Encoding #

Encode a token specifying that this is the beginning of an indefinite map of unknown size. Tokens representing the map are expected afterwords, followed by a break token (see encodeBreak) when the map has ended.

Since: 0.2.0.0

encodeBreak :: Encoding #

Encode a 'break', used to specify the end of indefinite length objects like maps or lists.

Since: 0.2.0.0

encodeTag :: Word -> Encoding #

Encode an arbitrary Word tag.

Since: 0.2.0.0

encodeTag64 :: Word64 -> Encoding #

Encode an arbitrary 64-bit Word64 tag.

Since: 0.2.0.0

encodeBool :: Bool -> Encoding #

Encode a Bool.

Since: 0.2.0.0

encodeUndef :: Encoding #

Encode an Undef value.

Since: 0.2.0.0

encodeNull :: Encoding #

Encode a Null value.

Since: 0.2.0.0

encodeSimple :: Word8 -> Encoding #

Encode a 'simple' CBOR token that can be represented with an 8-bit word. You probably don't ever need this.

Since: 0.2.0.0

encodeFloat16 :: Float -> Encoding #

Encode a small 16-bit Float in a flattened format.

Since: 0.2.0.0

encodeFloat :: Float -> Encoding #

Encode a full precision Float in a flattened format.

Since: 0.2.0.0

encodeDouble :: Double -> Encoding #

Encode a Double in a flattened format.

Since: 0.2.0.0