Safe Haskell	None
Language	Haskell2010

Dhall.Binary

Contents

Standard versions
Encoding and decoding
Exceptions

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
class ToTerm a where
- encode :: a -> Term
class FromTerm a where
- decode :: Term -> Maybe a
encodeExpression :: Expr s Import -> Term
decodeExpression :: FromTerm a => Term -> Either DecodingFailure (Expr s a)
data DecodingFailure = CBORIsNotDhall Term

Standard versions

data StandardVersion Source #

Supported version strings

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 #

Encoding and decoding

class ToTerm a where Source #

Types that can be encoded as a CBOR Term

Methods

encode :: a -> Term Source #

Instances

ToTerm Void Source #
Instance details Defined in Dhall.Binary Methods encode :: Void -> Term Source #
ToTerm Import Source #
Instance details Defined in Dhall.Binary Methods encode :: Import -> Term Source #
ToTerm a => ToTerm (Expr Void a) Source #
Instance details Defined in Dhall.Binary Methods encode :: Expr Void a -> Term Source #

class FromTerm a where Source #

Types that can be decoded from a CBOR Term

Methods

decode :: Term -> Maybe a Source #

Instances

FromTerm Void Source #
Instance details Defined in Dhall.Binary Methods decode :: Term -> Maybe Void Source #
FromTerm Import Source #
Instance details Defined in Dhall.Binary Methods decode :: Term -> Maybe Import Source #
FromTerm a => FromTerm (Expr s a) Source #
Instance details Defined in Dhall.Binary Methods decode :: Term -> Maybe (Expr s a) Source #

encodeExpression :: Expr s Import -> Term Source #

Encode a Dhall expression as a CBOR Term

This denotes the expression before encoding it. To encode an already denoted expression, it is more efficient to directly use encode.

decodeExpression :: FromTerm a => Term -> Either DecodingFailure (Expr s a) Source #

Decode a Dhall expression from a CBOR Term

Exceptions

data DecodingFailure Source #

Constructors

CBORIsNotDhall Term

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 #