| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Dhall.Binary
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
- 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 # | |
Defined in Dhall.Binary | |
| Enum StandardVersion Source # | |
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 # | |
Defined in Dhall.Binary Methods (==) :: DecodingFailure -> DecodingFailure -> Bool # (/=) :: DecodingFailure -> DecodingFailure -> Bool # | |
| Show DecodingFailure Source # | |
Defined in Dhall.Binary Methods showsPrec :: Int -> DecodingFailure -> ShowS # show :: DecodingFailure -> String # showList :: [DecodingFailure] -> ShowS # | |
| Exception DecodingFailure Source # | |
Defined in Dhall.Binary Methods toException :: DecodingFailure -> SomeException # | |