Dhall.Binary

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

Standard versions

data StandardVersion

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

Defined in Dhall.Binary

Methods

minBound :: StandardVersion

maxBound :: StandardVersion

Enum StandardVersion

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

Render a StandardVersion as Expr

Encoding and decoding

class ToTerm a where

Types that can be encoded as a CBOR Term

Methods

encode :: a -> Term

Instances

ToTerm Void

Defined in Dhall.Binary

Methods

encode :: Void -> Term

ToTerm Import

Defined in Dhall.Binary

Methods

encode :: Import -> Term

ToTerm DhallDouble

Defined in Dhall.Binary

Methods

encode :: DhallDouble -> Term

ToTerm a => ToTerm (Expr Void a)

Defined in Dhall.Binary

Methods

encode :: Expr Void a -> Term

class FromTerm a where

Types that can be decoded from a CBOR Term

Methods

decode :: Term -> Maybe a

Instances

FromTerm Void

Defined in Dhall.Binary

Methods

decode :: Term -> Maybe Void

FromTerm Import

Defined in Dhall.Binary

Methods

decode :: Term -> Maybe Import

FromTerm a => FromTerm (Expr s a)

Defined in Dhall.Binary

Methods

decode :: Term -> Maybe (Expr s a)

encodeExpression :: Expr s Import -> Term

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)

Decode a Dhall expression from a CBOR Term

Exceptions

data DecodingFailure

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

Constructors

CBORIsNotDhall Term

Instances

Eq DecodingFailure

Defined in Dhall.Binary

Methods

(==) :: DecodingFailure -> DecodingFailure -> Bool

(/=) :: DecodingFailure -> DecodingFailure -> Bool

Show DecodingFailure

Defined in Dhall.Binary

Methods

showsPrec :: Int -> DecodingFailure -> ShowS

show :: DecodingFailure -> String

showList :: [DecodingFailure] -> ShowS

Exception DecodingFailure

Defined in Dhall.Binary

Methods

toException :: DecodingFailure -> SomeException

fromException :: SomeException -> Maybe DecodingFailure

displayException :: DecodingFailure -> String