Safe Haskell	Safe-Inferred
Language	Haskell2010

Codec.Extras.SerialiseViaFlat

Synopsis

newtype SerialiseViaFlat a = SerialiseViaFlat {
- unSerialiseViaFlat :: a
}
decodeViaFlatWith :: Get a -> Decoder s a
data DeserialiseFailureInfo = DeserialiseFailureInfo {
- dfOffset :: ByteOffset
- dfReason :: DeserialiseFailureReason
}
data DeserialiseFailureReason
- = EndOfInput
- | ExpectedBytes
- | OtherReason String
readDeserialiseFailureInfo :: DeserialiseFailure -> DeserialiseFailureInfo

Documentation

newtype SerialiseViaFlat a Source #

Newtype to provide Serialise instances for types with a Flat instance that just encodes the flat-serialized value as a CBOR bytestring

Constructors

SerialiseViaFlat
Fields unSerialiseViaFlat :: a

Instances

Instances details

Flat a => Serialise (SerialiseViaFlat a) Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods encode :: SerialiseViaFlat a -> Encoding decode :: Decoder s (SerialiseViaFlat a) encodeList :: [SerialiseViaFlat a] -> Encoding decodeList :: Decoder s [SerialiseViaFlat a]

decodeViaFlatWith :: Get a -> Decoder s a Source #

data DeserialiseFailureInfo Source #

Similar to DeserialiseFailure, with the difference that plain string reason messages are turned into the datatype: DeserialiseFailureReason.

Constructors

DeserialiseFailureInfo
Fields dfOffset :: ByteOffset dfReason :: DeserialiseFailureReason

Instances

Instances details

Show DeserialiseFailureInfo Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods showsPrec :: Int -> DeserialiseFailureInfo -> ShowS Source # show :: DeserialiseFailureInfo -> String Source # showList :: [DeserialiseFailureInfo] -> ShowS Source #
Eq DeserialiseFailureInfo Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods (==) :: DeserialiseFailureInfo -> DeserialiseFailureInfo -> Bool Source # (/=) :: DeserialiseFailureInfo -> DeserialiseFailureInfo -> Bool Source #
Pretty DeserialiseFailureInfo Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods pretty :: DeserialiseFailureInfo -> Doc ann # prettyList :: [DeserialiseFailureInfo] -> Doc ann #

data DeserialiseFailureReason Source #

The reason of the cbor failure as a datatype, not as a plain string.

Constructors

EndOfInput	Not enough input provided
ExpectedBytes	The bytes inside the input are malformed.
OtherReason String	This is either a cbor failure that we (plutus) are not aware of, or an underlying flat failure. We use whatever message `cborg` or flat returns.

Instances

Instances details

Show DeserialiseFailureReason Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods showsPrec :: Int -> DeserialiseFailureReason -> ShowS Source # show :: DeserialiseFailureReason -> String Source # showList :: [DeserialiseFailureReason] -> ShowS Source #
Eq DeserialiseFailureReason Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods (==) :: DeserialiseFailureReason -> DeserialiseFailureReason -> Bool Source # (/=) :: DeserialiseFailureReason -> DeserialiseFailureReason -> Bool Source #
Pretty DeserialiseFailureReason Source #
Instance details Defined in Codec.Extras.SerialiseViaFlat Methods pretty :: DeserialiseFailureReason -> Doc ann # prettyList :: [DeserialiseFailureReason] -> Doc ann #

readDeserialiseFailureInfo :: DeserialiseFailure -> DeserialiseFailureInfo Source #

The errors returned by cborg are plain strings (untyped). With this function we try to map onto datatypes, those cborg error messages that we are interested in.

Currently we are only interested in error messages returned by the decodeBytes decoder; see scriptCBORDecoder.