Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.MemoBytes.Internal

Contents

Memoized
MemoBytes MemPack instance definitions
Raw equality

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
type family MemoHashIndex (t ∷ Type) ∷ Type
mkMemoBytes ∷ t → ByteString → MemoBytes t
mkMemoBytesStrict ∷ ∀ t. t → ByteString → MemoBytes t
getMemoBytesType ∷ MemoBytes t → t
getMemoBytesHash ∷ MemoBytes t → SafeHash (MemoHashIndex t)
memoBytes ∷ Version → Encode w t → MemoBytes t
memoBytesEra ∷ ∀ era w t. Era era ⇒ Encode w t → MemoBytes t
shorten ∷ ByteString → ShortByteString
showMemo ∷ Show t ⇒ MemoBytes t → String
printMemo ∷ Show t ⇒ MemoBytes t → IO ()
shortToLazy ∷ ShortByteString → ByteString
contentsEq ∷ Eq t ⇒ MemoBytes t → MemoBytes t → Bool
decodeMemoBytes ∷ (DecCBOR t, MonadFail m) ⇒ Version → ByteString → m (MemoBytes t)
class Memoized t where
- type RawType t = (r ∷ Type) | r → t
mkMemoized ∷ ∀ t. (EncCBOR (RawType t), Memoized t) ⇒ Version → RawType t → t
mkMemoizedEra ∷ ∀ era t. (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 ∷ ∀ t. (Memoized t, Eq (RawType t)) ⇒ t → t → Bool
getMemoRawBytes ∷ Memoized t ⇒ t → ShortByteString
lensMemoRawType ∷ ∀ era t a b. (Era era, EncCBOR (RawType t), Memoized t) ⇒ (RawType t → a) → (RawType t → b → RawType t) → Lens t t a b
getterMemoRawType ∷ Memoized t ⇒ (RawType t → a) → SimpleGetter t a
byteCountMemoBytes ∷ MemoBytes t → Int
packMemoBytesM ∷ MemoBytes t → Pack s ()
unpackMemoBytesM ∷ (DecCBOR t, Buffer b) ⇒ Version → Unpack b (MemoBytes t)
class EqRaw a where
- eqRaw ∷ a → a → Bool

Documentation

data MemoBytes t Source #

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 mbRawType ∷ !t mbBytes ∷ ShortByteString mbHash ∷ SafeHash (MemoHashIndex t)

Bundled Patterns

pattern Memo ∷ t → ShortByteString → MemoBytes t

Instances

Instances details

Generic (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Associated Types type Rep (MemoBytes t) ∷ Type → Type # Methods from ∷ MemoBytes t → Rep (MemoBytes t) x # to ∷ Rep (MemoBytes t) x → MemoBytes t #
Show t ⇒ Show (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods showsPrec ∷ Int → MemoBytes t → ShowS # show ∷ MemoBytes t → String # showList ∷ [MemoBytes t] → ShowS #
Typeable t ⇒ ToCBOR (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods toCBOR ∷ MemoBytes t → Encoding Source # encodedSizeExpr ∷ (∀ t0. ToCBOR t0 ⇒ Proxy t0 → Size) → Proxy (MemoBytes t) → Size Source # encodedListSizeExpr ∷ (∀ t0. ToCBOR t0 ⇒ Proxy t0 → Size) → Proxy [MemoBytes t] → Size Source #
DecCBOR t ⇒ DecCBOR (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods decCBOR ∷ Decoder s (MemoBytes t) Source # dropCBOR ∷ Proxy (MemoBytes t) → Decoder s () Source # label ∷ Proxy (MemoBytes t) → Text Source #
SafeToHash (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods originalBytes ∷ MemoBytes t → ByteString Source # originalBytesSize ∷ MemoBytes t → Int Source # makeHashWithExplicitProxys ∷ Proxy i → MemoBytes t → SafeHash i Source #
NFData t ⇒ NFData (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods rnf ∷ MemoBytes t → () #
Eq t ⇒ Eq (MemoBytes t) Source #	Both binary representation and Haskell types are compared.
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods (==) ∷ MemoBytes t → MemoBytes t → Bool # (/=) ∷ MemoBytes t → MemoBytes t → Bool #
(Typeable t, NoThunks t) ⇒ NoThunks (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal Methods noThunks ∷ Context → MemoBytes t → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → MemoBytes t → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (MemoBytes t) → String Source #
type Rep (MemoBytes t) Source #
Instance details Defined in Cardano.Ledger.MemoBytes.Internal type Rep (MemoBytes t) = D1 ('MetaData "MemoBytes" "Cardano.Ledger.MemoBytes.Internal" "cardano-ledger-core-1.18.0.0-inplace" 'False) (C1 ('MetaCons "MemoBytes" 'PrefixI 'True) (S1 ('MetaSel ('Just "mbRawType") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 t) :: (S1 ('MetaSel ('Just "mbBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString) :: S1 ('MetaSel ('Just "mbHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SafeHash (MemoHashIndex t))))))

type family MemoHashIndex (t ∷ Type) ∷ Type Source #

Instances

Instances details

type MemoHashIndex (PlutusData era) Source #
Instance details Defined in Cardano.Ledger.Plutus.Data type MemoHashIndex (PlutusData era) = EraIndependentData

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. 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 ∷ 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 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.

shorten ∷ ByteString → ShortByteString Source #

Deprecated: As unused. Use toShort . toStrict instead

Turn a lazy bytestring into a short bytestring.

showMemo ∷ Show t ⇒ MemoBytes t → String Source #

Deprecated: As unused. Show instance will show the hash, which is enough most of the time

Turn a MemoBytes into a string, showing both its internal structure and its original bytes. Useful since the Show instance of MemoBytes does not display the original bytes.

printMemo ∷ Show t ⇒ MemoBytes t → IO () Source #

Deprecated: As unused. Show instance will show the hash, which is enough most of the time

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 ∷ (DecCBOR t, MonadFail m) ⇒ Version → ByteString → m (MemoBytes t) Source #

Memoized

class Memoized t Source #

Class that relates the actual type with its raw and byte representations

Associated Types

type RawType t = (r ∷ Type) | r → t Source #

Instances

Instances details

Memoized (Data era) Source #
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type RawType (Data era) = (r ∷ Type) Source # Methods getMemoBytes ∷ Data era → MemoBytes (RawType (Data era)) wrapMemoBytes ∷ MemoBytes (RawType (Data era)) → Data era

mkMemoized ∷ ∀ t. (EncCBOR (RawType t), Memoized t) ⇒ Version → RawType t → t Source #

Construct memoized type from the raw type using its EncCBOR instance

mkMemoizedEra ∷ ∀ era t. (Era era, EncCBOR (RawType t), Memoized t) ⇒ RawType t → t Source #

decodeMemoized ∷ Decoder s t → Decoder s (MemoBytes t) Source #

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.

eqRawType ∷ ∀ t. (Memoized t, Eq (RawType t)) ⇒ t → t → Bool Source #

getMemoRawBytes ∷ Memoized t ⇒ t → ShortByteString Source #

Extract the raw bytes from the memoized version

lensMemoRawType ∷ ∀ era t a b. (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.

getterMemoRawType ∷ Memoized t ⇒ (RawType t → a) → SimpleGetter t a Source #

This is a helper SimpleGetter creator for any Memoized type

MemoBytes MemPack instance definitions

byteCountMemoBytes ∷ MemoBytes t → Int Source #

packMemoBytesM ∷ MemoBytes t → Pack s () Source #

unpackMemoBytesM ∷ (DecCBOR t, Buffer b) ⇒ Version → Unpack b (MemoBytes t) Source #

Raw equality

class EqRaw a where Source #

Type class that implements equality on the Haskell type, ignoring any of the potentially memoized binary representation of the type.

Minimal complete definition

Nothing

Methods

eqRaw ∷ a → a → Bool Source #

default eqRaw ∷ (a ~ t, Memoized t, Eq (RawType t)) ⇒ a → a → Bool Source #