cborg-0.2.0.0: Concise Binary Object Representation

Copyright (c) Duncan Coutts 2015-2017 BSD3-style (see LICENSE.txt) duncan@community.haskell.org experimental non-portable (GHC extensions) None Haskell2010

Codec.CBOR.FlatTerm

Contents

Description

A simpler form than CBOR for writing out Encoding values that allows easier verification and testing. While this library primarily focuses on taking Encoding values (independent of any underlying format) and serializing them into CBOR format, this module offers an alternative format called FlatTerm for serializing Encoding values.

The FlatTerm form is very simple and internally mirrors the original Encoding type very carefully. The intention here is that once you have Encoding and Decoding values for your types, you can round-trip values through FlatTerm to catch bugs more easily and with a smaller amount of code to look through.

For that reason, this module is primarily useful for client libraries, and even then, only for their test suites to offer a simpler form for doing encoding tests and catching problems in an encoder and decoder.

Synopsis

# Types

type FlatTerm = [TermToken] Source #

A "flat" representation of an Encoding value, useful for round-tripping and writing tests.

Since: 0.2.0.0

data TermToken Source #

A concrete encoding of Encoding values, one which mirrors the original Encoding type closely.

Since: 0.2.0.0

Instances

 Source # Methods Source # Methods Source # MethodsshowList :: [TermToken] -> ShowS #

# Functions

Arguments

 :: Encoding The input Encoding. -> FlatTerm The resulting FlatTerm.

Convert an arbitrary Encoding into a FlatTerm.

Since: 0.2.0.0

Arguments

 :: (forall s. Decoder s a) A Decoder for a serialised value. -> FlatTerm The serialised FlatTerm. -> Either String a The deserialised value, or an error.

Given a Decoder, decode a FlatTerm back into an ordinary value, or return an error.

Since: 0.2.0.0

Arguments

 :: FlatTerm The input FlatTerm -> Bool True if valid, False otherwise.

Ensure a FlatTerm is internally consistent and was created in a valid manner.

Since: 0.2.0.0