| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Cardano.Binary
Synopsis
- class Typeable a ⇒ ToCBOR a where
- toCBOR ∷ a → Encoding
- encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy a → Size
- encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [a] → Size
- withWordSize ∷ (Integral s, Integral a) ⇒ s → a
- module Codec.CBOR.Encoding
- encodeMaybe ∷ (a → Encoding) → Maybe a → Encoding
- toCBORMaybe ∷ (a → Encoding) → Maybe a → Encoding
- encodeNullMaybe ∷ (a → Encoding) → Maybe a → Encoding
- encodeSeq ∷ (a → Encoding) → Seq a → Encoding
- encodeNominalDiffTime ∷ NominalDiffTime → Encoding
- encodeNominalDiffTimeMicro ∷ NominalDiffTime → Encoding
- data Range b = Range {}
- szEval ∷ (∀ t. ToCBOR t ⇒ (Proxy t → Size) → Proxy t → Range Natural) → Size → Range Natural
- type Size = Fix SizeF
- data Case t = Case Text t
- caseValue ∷ Case t → t
- newtype LengthOf xs = LengthOf xs
- data SizeOverride
- = SizeConstant Size
- | SizeExpression ((∀ a. ToCBOR a ⇒ Proxy a → Size) → Size)
- | SelectCases [Text]
- isTodo ∷ Size → Bool
- szCases ∷ [Case Size] → Size
- szLazy ∷ ToCBOR a ⇒ Proxy a → Size
- szGreedy ∷ ToCBOR a ⇒ Proxy a → Size
- szForce ∷ Size → Size
- szWithCtx ∷ ToCBOR a ⇒ Map TypeRep SizeOverride → Proxy a → Size
- szSimplify ∷ Size → Either Size (Range Natural)
- apMono ∷ Text → (Natural → Natural) → Size → Size
- szBounds ∷ ToCBOR a ⇒ a → Either Size (Range Natural)
- serialize ∷ ToCBOR a ⇒ a → ByteString
- serialize' ∷ ToCBOR a ⇒ a → ByteString
- serializeBuilder ∷ ToCBOR a ⇒ a → Builder
- serializeEncoding ∷ Encoding → ByteString
- serializeEncoding' ∷ Encoding → ByteString
- encodeNestedCbor ∷ ToCBOR a ⇒ a → Encoding
- encodeNestedCborBytes ∷ ByteString → Encoding
- nestedCborSizeExpr ∷ Size → Size
- nestedCborBytesSizeExpr ∷ Size → Size
- class Typeable a ⇒ FromCBOR a where
- data DecoderError
- = DecoderErrorCanonicityViolation Text
- | DecoderErrorCustom Text Text
- | DecoderErrorDeserialiseFailure Text DeserialiseFailure
- | DecoderErrorEmptyList Text
- | DecoderErrorLeftover Text ByteString
- | DecoderErrorSizeMismatch Text Int Int
- | DecoderErrorUnknownTag Text Word8
- | DecoderErrorVoid
- enforceSize ∷ Text → Int → Decoder s ()
- matchSize ∷ Text → Int → Int → Decoder s ()
- module Codec.CBOR.Decoding
- decodeMaybe ∷ Decoder s a → Decoder s (Maybe a)
- fromCBORMaybe ∷ Decoder s a → Decoder s (Maybe a)
- decodeNullMaybe ∷ Decoder s a → Decoder s (Maybe a)
- decodeSeq ∷ Decoder s a → Decoder s (Seq a)
- decodeListWith ∷ Decoder s a → Decoder s [a]
- decodeNominalDiffTime ∷ Decoder s NominalDiffTime
- decodeNominalDiffTimeMicro ∷ Decoder s NominalDiffTime
- decodeMapSkel ∷ (Ord k, FromCBOR k, FromCBOR v) ⇒ ([(k, v)] → m) → Decoder s m
- decodeCollection ∷ Decoder s (Maybe Int) → Decoder s a → Decoder s [a]
- decodeCollectionWithLen ∷ Decoder s (Maybe Int) → Decoder s v → Decoder s (Int, [v])
- cborError ∷ (MonadFail m, Buildable e) ⇒ e → m a
- toCborError ∷ (MonadFail m, Buildable e) ⇒ Either e a → m a
- unsafeDeserialize ∷ FromCBOR a ⇒ ByteString → a
- unsafeDeserialize' ∷ FromCBOR a ⇒ ByteString → a
- toStrictByteString ∷ Encoding → ByteString
- decodeFull ∷ ∀ a. FromCBOR a ⇒ ByteString → Either DecoderError a
- decodeFull' ∷ ∀ a. FromCBOR a ⇒ ByteString → Either DecoderError a
- decodeFullDecoder ∷ Text → (∀ s. Decoder s a) → ByteString → Either DecoderError a
- decodeFullDecoder' ∷ Text → (∀ s. Decoder s a) → ByteString → Either DecoderError a
- decodeNestedCbor ∷ FromCBOR a ⇒ Decoder s a
- decodeNestedCborBytes ∷ Decoder s ByteString
Documentation
class Typeable a ⇒ ToCBOR a where Source #
Minimal complete definition
Methods
toCBOR ∷ a → Encoding Source #
encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy a → Size Source #
encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [a] → Size Source #
Instances
withWordSize ∷ (Integral s, Integral a) ⇒ s → a Source #
Compute encoded size of an integer
module Codec.CBOR.Encoding
encodeMaybe ∷ (a → Encoding) → Maybe a → Encoding Source #
toCBORMaybe ∷ (a → Encoding) → Maybe a → Encoding Source #
Deprecated: In favor of encodeMaybe
encodeNullMaybe ∷ (a → Encoding) → Maybe a → Encoding Source #
Alternative way to encode a Maybe type.
Note - this is not the default method for encoding Maybe, use encodeMaybe instead
encodeNominalDiffTime ∷ NominalDiffTime → Encoding Source #
encodeNominalDiffTimeMicro ∷ NominalDiffTime → Encoding Source #
Same as encodeNominalDiffTime, except with loss of precision, because it encoded as
Micro
Size of expressions
A range of values. Should satisfy the invariant forall x. lo x <= hi x.
Instances
| (Ord b, Num b) ⇒ Num (Range b) Source # | The |
| Buildable (Range Natural) Source # | |
Defined in Cardano.Binary.ToCBOR | |
szEval ∷ (∀ t. ToCBOR t ⇒ (Proxy t → Size) → Proxy t → Range Natural) → Size → Range Natural Source #
Fully evaluate a size expression by applying the given function to any
suspended computations. szEval g effectively turns each "thunk"
of the form TodoF f x into g x, then evaluates the result.
type Size = Fix SizeF Source #
Expressions describing the statically-computed size bounds on a type's possible values.
An individual labeled case.
Constructors
| Case Text t |
A type used to represent the length of a value in Size computations.
Constructors
| LengthOf xs |
data SizeOverride Source #
Override mechanisms to be used with szWithCtx.
Constructors
| SizeConstant Size | Replace with a fixed |
| SizeExpression ((∀ a. ToCBOR a ⇒ Proxy a → Size) → Size) | Recursively compute the size. |
| SelectCases [Text] | Select only a specific case from a |
szLazy ∷ ToCBOR a ⇒ Proxy a → Size Source #
Evaluate the expression lazily, by immediately creating a thunk that will evaluate its contents lazily.
ghci> putStrLn $ pretty $ szLazy (Proxy @TxAux) (_ :: TxAux)
szGreedy ∷ ToCBOR a ⇒ Proxy a → Size Source #
Evaluate an expression greedily. There may still be thunks in the
result, for types that did not provide a custom encodedSizeExpr method
in their ToCBOR instance.
ghci> putStrLn $ pretty $ szGreedy (Proxy @TxAux)
(0 + { TxAux=(2 + ((0 + (((1 + (2 + ((_ :: LengthOf [TxIn]) * (2 + { TxInUtxo=(2 + ((1 + 34) + { minBound=1 maxBound=5 })) })))) + (2 + ((_ :: LengthOf [TxOut]) * (0 + { TxOut=(2 + ((0 + ((2 + ((2 + withWordSize((((1 + 30) + (_ :: Attributes AddrAttributes)) + 1))) + (((1 + 30) + (_ :: Attributes AddrAttributes)) + 1))) + { minBound=1 maxBound=5 })) + { minBound=1 maxBound=9 })) })))) + (_ :: Attributes ()))) + (_ :: Vector TxInWitness))) })szForce ∷ Size → Size Source #
Force any thunks in the given Size expression.
ghci> putStrLn $ pretty $ szForce $ szLazy (Proxy @TxAux)
(0 + { TxAux=(2 + ((0 + (_ :: Tx)) + (_ :: Vector TxInWitness))) })szWithCtx ∷ ToCBOR a ⇒ Map TypeRep SizeOverride → Proxy a → Size Source #
Greedily compute the size bounds for a type, using the given context to override sizes for specific types.
szSimplify ∷ Size → Either Size (Range Natural) Source #
Simplify the given Size, resulting in either the simplified Size or,
if it was fully simplified, an explicit upper and lower bound.
apMono ∷ Text → (Natural → Natural) → Size → Size Source #
Apply a monotonically increasing function to the expression.
There are three cases when applying f to a Size expression:
* When applied to a value x, compute f x.
* When applied to cases, apply to each case individually.
* In all other cases, create a deferred application of f.
serialize ∷ ToCBOR a ⇒ a → ByteString Source #
Serialize a Haskell value with a ToCBOR instance to an external binary
representation.
The output is represented as a lazy LByteString and is constructed
incrementally.
serialize' ∷ ToCBOR a ⇒ a → ByteString Source #
Serialize a Haskell value to an external binary representation.
The output is represented as a strict ByteString.
serializeBuilder ∷ ToCBOR a ⇒ a → Builder Source #
Serialize into a Builder. Useful if you want to throw other ByteStrings around it.
serializeEncoding ∷ Encoding → ByteString Source #
serializeEncoding' ∷ Encoding → ByteString Source #
A strict version of serializeEncoding
CBOR in CBOR
encodeNestedCbor ∷ ToCBOR a ⇒ a → Encoding Source #
Encode and serialise the given a and sorround it with the semantic tag 24
In CBOR diagnostic notation:
>>> 24(hDEADBEEF)
encodeNestedCborBytes ∷ ByteString → Encoding Source #
Like encodeNestedCbor, but assumes nothing about the shape of
input object, so that it must be passed as a binary ByteString blob. It's
the caller responsibility to ensure the input ByteString correspond
indeed to valid, previously-serialised CBOR data.
class Typeable a ⇒ FromCBOR a where Source #
Minimal complete definition
Instances
data DecoderError Source #
Constructors
| DecoderErrorCanonicityViolation Text | |
| DecoderErrorCustom Text Text | Custom decoding error, usually due to some validation failure |
| DecoderErrorDeserialiseFailure Text DeserialiseFailure | |
| DecoderErrorEmptyList Text | |
| DecoderErrorLeftover Text ByteString | |
| DecoderErrorSizeMismatch Text Int Int | A size mismatch |
| DecoderErrorUnknownTag Text Word8 | |
| DecoderErrorVoid |
Instances
| Exception DecoderError Source # | |
Defined in Cardano.Binary.FromCBOR Methods toException ∷ DecoderError → SomeException # fromException ∷ SomeException → Maybe DecoderError # displayException ∷ DecoderError → String # | |
| Show DecoderError Source # | |
Defined in Cardano.Binary.FromCBOR Methods showsPrec ∷ Int → DecoderError → ShowS show ∷ DecoderError → String showList ∷ [DecoderError] → ShowS | |
| Buildable DecoderError Source # | |
Defined in Cardano.Binary.FromCBOR Methods build ∷ DecoderError → Builder Source # | |
| Eq DecoderError Source # | |
Defined in Cardano.Binary.FromCBOR | |
enforceSize ∷ Text → Int → Decoder s () Source #
Enforces that the input size is the same as the decoded one, failing in case it's not
matchSize ∷ Text → Int → Int → Decoder s () Source #
Compare two sizes, failing if they are not equal
module Codec.CBOR.Decoding
decodeMaybe ∷ Decoder s a → Decoder s (Maybe a) Source #
fromCBORMaybe ∷ Decoder s a → Decoder s (Maybe a) Source #
Deprecated: In favor of decodeMaybe
decodeNullMaybe ∷ Decoder s a → Decoder s (Maybe a) Source #
decodeNominalDiffTime ∷ Decoder s NominalDiffTime Source #
decodeNominalDiffTimeMicro ∷ Decoder s NominalDiffTime Source #
For backwards compatibility we round pico precision to micro
Helper tools to build instances
decodeMapSkel ∷ (Ord k, FromCBOR k, FromCBOR v) ⇒ ([(k, v)] → m) → Decoder s m Source #
Checks canonicity by comparing the new key being decoded with the previous one, to enfore these are sorted the correct way. See: https://tools.ietf.org/html/rfc7049#section-3.9 "[..]The keys in every map must be sorted lowest value to highest.[...]"
cborError ∷ (MonadFail m, Buildable e) ⇒ e → m a Source #
Convert a Buildable error message into a MonadFail failure.
toCborError ∷ (MonadFail m, Buildable e) ⇒ Either e a → m a Source #
Convert an Either-encoded failure to a MonadFail failure using the Buildable
insatance
Unsafe deserialization
unsafeDeserialize ∷ FromCBOR a ⇒ ByteString → a Source #
Deserialize a Haskell value from the external binary representation
(which must have been made using serialize or related function).
Throws: DeserialiseFailure
unsafeDeserialize' ∷ FromCBOR a ⇒ ByteString → a Source #
Strict variant of deserialize.
Turn an Encoding into a strict ByteString in CBOR binary
format.
Since: cborg-0.2.0.0
Decoding
decodeFull ∷ ∀ a. FromCBOR a ⇒ ByteString → Either DecoderError a Source #
Deserialize a Haskell value from the external binary representation,
failing if there are leftovers. In a nutshell, the full here implies
the contract of this function is that what you feed as input needs to
be consumed entirely.
decodeFull' ∷ ∀ a. FromCBOR a ⇒ ByteString → Either DecoderError a Source #
Arguments
| ∷ Text | Label for error reporting |
| → (∀ s. Decoder s a) | The parser for the |
| → ByteString | The |
| → Either DecoderError a |
Arguments
| ∷ Text | Label for error reporting |
| → (∀ s. Decoder s a) | The parser for the |
| → ByteString | The |
| → Either DecoderError a |
CBOR in CBOR
decodeNestedCbor ∷ FromCBOR a ⇒ Decoder s a Source #
Remove the the semantic tag 24 from the enclosed CBOR data item,
decoding back the inner ByteString as a proper Haskell type.
Consume its input in full.
decodeNestedCborBytes ∷ Decoder s ByteString Source #
Like decodeKnownCborDataItem, but assumes nothing about the Haskell
type we want to deserialise back, therefore it yields the ByteString
Tag 24 surrounded (stripping such tag away).
In CBOR notation, if the data was serialised as:
>>>24(h'DEADBEEF')
then decodeNestedCborBytes yields the inner DEADBEEF, unchanged.