| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Cardano.Ledger.MemoBytes.Internal
Description
Provides MemoBytes internals
Warning
This module is considered internal.
The contents of this module may change in any way whatsoever and without any warning between minor versions of this package.
Synopsis
- data MemoBytes t where
- MemoBytes {
- mbRawType ∷ !t
- mbBytes ∷ ShortByteString
- mbHash ∷ SafeHash (MemoHashIndex t)
- pattern Memo ∷ t → ShortByteString → MemoBytes t
- MemoBytes {
- type Mem t = Annotator (MemoBytes t)
- type family MemoHashIndex t
- mkMemoBytes ∷ t → ByteString → MemoBytes t
- mkMemoBytesStrict ∷ t → ByteString → MemoBytes t
- getMemoBytesType ∷ MemoBytes t → t
- getMemoBytesHash ∷ MemoBytes t → SafeHash (MemoHashIndex t)
- memoBytes ∷ ∀ (w ∷ Wrapped) t. Version → Encode w t → MemoBytes t
- memoBytesEra ∷ ∀ era (w ∷ Wrapped) t. Era era ⇒ Encode w t → MemoBytes t
- shortToLazy ∷ ShortByteString → ByteString
- contentsEq ∷ Eq t ⇒ MemoBytes t → MemoBytes t → Bool
- decodeMemoBytes ∷ (Typeable t, DecCBOR (Annotator t), MonadFail m) ⇒ Version → ByteString → m (MemoBytes t)
- class Memoized t where
- mkMemoized ∷ (EncCBOR (RawType t), Memoized t) ⇒ Version → RawType t → t
- mkMemoizedEra ∷ (Era era, EncCBOR (RawType t), Memoized t) ⇒ RawType t → t
- decodeMemoized ∷ Decoder s t → Decoder s (MemoBytes t)
- getMemoSafeHash ∷ Memoized t ⇒ t → SafeHash (MemoHashIndex (RawType t))
- getMemoRawType ∷ Memoized t ⇒ t → RawType t
- zipMemoRawType ∷ (Memoized t1, Memoized t2) ⇒ (RawType t1 → RawType t2 → a) → t1 → t2 → a
- eqRawType ∷ (Memoized t, Eq (RawType t)) ⇒ t → t → Bool
- getMemoRawBytes ∷ Memoized t ⇒ t → ShortByteString
- lensMemoRawType ∷ (Era era, EncCBOR (RawType t), Memoized t) ⇒ (RawType t → a) → (RawType t → b → RawType t) → Lens t t a b
- memoRawTypeL ∷ (Era era, EncCBOR (RawType t), Memoized t) ⇒ Lens' t (RawType t)
- byteCountMemoBytes ∷ MemoBytes t → Int
- packMemoBytesM ∷ MemoBytes t → Pack s ()
- unpackMemoBytesM ∷ (DecCBOR (Annotator t), Typeable t, Buffer b) ⇒ Version → Unpack s b (MemoBytes t)
- class EqRaw a where
Documentation
Pair together a type t and its serialization. Used to encode a type
that is serialized over the network, and to remember the original bytes
that were used to transmit it. Important since hashes are computed
from the serialization of a type, and EncCBOR instances do not have unique
serializations.
Constructors
| MemoBytes | |
Fields
| |
Bundled Patterns
| pattern Memo ∷ t → ShortByteString → MemoBytes t | Prevent coercion on MemoBytes because it does not preserve the invariants |
Instances
type Mem t = Annotator (MemoBytes t) Source #
Useful when deriving DecCBOR(Annotator T) deriving via (Mem T) instance DecCBOR (Annotator T)
type family MemoHashIndex t Source #
Instances
| type MemoHashIndex (PlutusData era) Source # | |
Defined in Cardano.Ledger.Plutus.Data | |
mkMemoBytes ∷ t → ByteString → MemoBytes t Source #
Constructor that takes the underlying type and the original bytes as lazy
ByteString.
Warning - This is a dangerous constructor because it allows one to construct a MemoBytes type
with wrong bytes.
mkMemoBytesStrict ∷ t → ByteString → MemoBytes t Source #
Same as mkMemoBytes, but with strict bytes
getMemoBytesType ∷ MemoBytes t → t Source #
Extract the inner type of the MemoBytes
getMemoBytesHash ∷ MemoBytes t → SafeHash (MemoHashIndex t) Source #
Extract the hash value of the binary representation of the MemoBytes
memoBytes ∷ ∀ (w ∷ Wrapped) t. Version → Encode w t → MemoBytes t Source #
Create MemoBytes from its CBOR encoding
Warning - This is a dangerous constructor because it allows one to construct a MemoBytes type
from the wrong encoding. Use mkMemoized instead when possible.
memoBytesEra ∷ ∀ era (w ∷ Wrapped) t. Era era ⇒ Encode w t → MemoBytes t Source #
Same as memoBytes, but derives Version from the era.
Warning - This is a dangerous constructor because it allows one to construct a MemoBytes type
from the wrong encoding. Use mkMemoizedEra instead when possible.
shortToLazy ∷ ShortByteString → ByteString Source #
Helper function. Converts a short bytestring to a lazy bytestring.
contentsEq ∷ Eq t ⇒ MemoBytes t → MemoBytes t → Bool Source #
Returns true if the contents of the MemoBytes are equal
decodeMemoBytes ∷ (Typeable t, DecCBOR (Annotator t), MonadFail m) ⇒ Version → ByteString → m (MemoBytes t) Source #
Memoized
Class that relates the actual type with its raw and byte representations
Instances
| Memoized (Data era) Source # | |||||
Defined in Cardano.Ledger.Plutus.Data Associated Types
Methods getMemoBytes ∷ Data era → MemoBytes (RawType (Data era)) wrapMemoBytes ∷ MemoBytes (RawType (Data era)) → Data era | |||||
mkMemoized ∷ (EncCBOR (RawType t), Memoized t) ⇒ Version → RawType t → t Source #
Construct memoized type from the raw type using its EncCBOR instance
getMemoSafeHash ∷ Memoized t ⇒ t → SafeHash (MemoHashIndex (RawType t)) Source #
Extract memoized SafeHash
getMemoRawType ∷ Memoized t ⇒ t → RawType t Source #
Extract the raw type from the memoized version
zipMemoRawType ∷ (Memoized t1, Memoized t2) ⇒ (RawType t1 → RawType t2 → a) → t1 → t2 → a Source #
This is a helper function that operates on raw types of two memoized types.
getMemoRawBytes ∷ Memoized t ⇒ t → ShortByteString Source #
Extract the raw bytes from the memoized version
lensMemoRawType ∷ (Era era, EncCBOR (RawType t), Memoized t) ⇒ (RawType t → a) → (RawType t → b → RawType t) → Lens t t a b Source #
This is a helper Lens creator for any Memoized type.
MemoBytes MemPack instance definitions
byteCountMemoBytes ∷ MemoBytes t → Int Source #
packMemoBytesM ∷ MemoBytes t → Pack s () Source #
unpackMemoBytesM ∷ (DecCBOR (Annotator t), Typeable t, Buffer b) ⇒ Version → Unpack s b (MemoBytes t) Source #
Raw equality
Type class that implements equality on the Haskell type, ignoring any of the potentially memoized binary representation of the type.
Minimal complete definition
Nothing