Safe Haskell	None
Language	Haskell2010

Dhall.Binary

Contents

Standard versions
Encoding and decoding
Exceptions
Orphan instances

Description

This module contains logic for converting Dhall expressions to and from CBOR expressions which can in turn be converted to and from a binary representation

Synopsis

data StandardVersion
- = NoVersion
- | V_5_0_0
- | V_4_0_0
- | V_3_0_0
- | V_2_0_0
- | V_1_0_0
renderStandardVersion :: StandardVersion -> Text
encodeExpression :: Serialise (Expr Void a) => Expr Void a -> ByteString
decodeExpression :: Serialise (Expr s a) => ByteString -> Either DecodingFailure (Expr s a)
newtype DecodingFailure = CBORIsNotDhall ByteString

Standard versions

data StandardVersion Source #

Supported version strings

This exists primarily for backwards compatibility for expressions encoded before Dhall removed version tags from the binary encoding

Constructors

NoVersion	No version string
V_5_0_0	Version "5.0.0"
V_4_0_0	Version "4.0.0"
V_3_0_0	Version "3.0.0"
V_2_0_0	Version "2.0.0"
V_1_0_0	Version "1.0.0"

Instances

Bounded StandardVersion Source #
Instance details Defined in Dhall.Binary Methods minBound :: StandardVersion # maxBound :: StandardVersion #
Enum StandardVersion Source #
Instance details Defined in Dhall.Binary Methods succ :: StandardVersion -> StandardVersion # pred :: StandardVersion -> StandardVersion # toEnum :: Int -> StandardVersion # fromEnum :: StandardVersion -> Int # enumFrom :: StandardVersion -> [StandardVersion] # enumFromThen :: StandardVersion -> StandardVersion -> [StandardVersion] # enumFromTo :: StandardVersion -> StandardVersion -> [StandardVersion] # enumFromThenTo :: StandardVersion -> StandardVersion -> StandardVersion -> [StandardVersion] #

renderStandardVersion :: StandardVersion -> Text Source #

Render a StandardVersion as Text

Encoding and decoding

encodeExpression :: Serialise (Expr Void a) => Expr Void a -> ByteString Source #

Encode a Dhall expression as a CBOR-encoded ByteString

decodeExpression :: Serialise (Expr s a) => ByteString -> Either DecodingFailure (Expr s a) Source #

Decode a Dhall expression from a CBOR Term

Exceptions

newtype DecodingFailure Source #

This indicates that a given CBOR-encoded ByteString did not correspond to a valid Dhall expression

Constructors

CBORIsNotDhall ByteString

Instances

Eq DecodingFailure Source #
Instance details Defined in Dhall.Binary Methods (==) :: DecodingFailure -> DecodingFailure -> Bool # (/=) :: DecodingFailure -> DecodingFailure -> Bool #
Show DecodingFailure Source #
Instance details Defined in Dhall.Binary Methods showsPrec :: Int -> DecodingFailure -> ShowS # show :: DecodingFailure -> String # showList :: [DecodingFailure] -> ShowS #
Exception DecodingFailure Source #
Instance details Defined in Dhall.Binary Methods toException :: DecodingFailure -> SomeException # fromException :: SomeException -> Maybe DecodingFailure # displayException :: DecodingFailure -> String #

Orphan instances

Serialise (Expr Void Void) Source #
Instance details Methods encode :: Expr Void Void -> Encoding # decode :: Decoder s (Expr Void Void) # encodeList :: [Expr Void Void] -> Encoding # decodeList :: Decoder s [Expr Void Void] #
Serialise (Expr Void Import) Source #
Instance details Methods encode :: Expr Void Import -> Encoding # decode :: Decoder s (Expr Void Import) # encodeList :: [Expr Void Import] -> Encoding # decodeList :: Decoder s [Expr Void Import] #