Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Chain.Common.Attributes

Description

Helper data type for block, tx attributes

Map with integer 1-byte keys, arbitrary-type polymorph values. Needed primarily for partial serialization. Values are either parsed and put to some constructor or left as unparsed.

Synopsis

newtype UnparsedFields = UnparsedFields (Map Word8 ByteString)
data Attributes h = Attributes {
- attrData ∷ !h
- attrRemain ∷ !UnparsedFields
}
attributesAreKnown ∷ Attributes a → Bool
unknownAttributesLength ∷ Attributes a → Int
encCBORAttributes ∷ ∀ t. [(Word8, t → ByteString)] → Attributes t → Encoding
decCBORAttributes ∷ ∀ t s. t → (Word8 → ByteString → t → Decoder s (Maybe t)) → Decoder s (Attributes t)
mkAttributes ∷ h → Attributes h
dropAttributes ∷ Dropper s
dropEmptyAttributes ∷ Dropper s

Documentation

newtype UnparsedFields Source #

Representation of unparsed fields in Attributes. Newtype wrapper is used for clear backward compatibility between previous representation (which was just a single ByteString) during transition from Store to CBOR.

Constructors

UnparsedFields (Map Word8 ByteString)

Instances

Instances details

ToJSON UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods toJSON ∷ UnparsedFields → Value Source # toEncoding ∷ UnparsedFields → Encoding Source # toJSONList ∷ [UnparsedFields] → Value Source # toEncodingList ∷ [UnparsedFields] → Encoding Source # omitField ∷ UnparsedFields → Bool Source #
Generic UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Associated Types type Rep UnparsedFields ∷ Type → Type Source # Methods from ∷ UnparsedFields → Rep UnparsedFields x Source # to ∷ Rep UnparsedFields x → UnparsedFields Source #
Show UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods showsPrec ∷ Int → UnparsedFields → ShowS Source # show ∷ UnparsedFields → String Source # showList ∷ [UnparsedFields] → ShowS Source #
NFData UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods rnf ∷ UnparsedFields → () Source #
Eq UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods (==) ∷ UnparsedFields → UnparsedFields → Bool Source # (/=) ∷ UnparsedFields → UnparsedFields → Bool Source #
Ord UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods compare ∷ UnparsedFields → UnparsedFields → Ordering Source # (<) ∷ UnparsedFields → UnparsedFields → Bool Source # (<=) ∷ UnparsedFields → UnparsedFields → Bool Source # (>) ∷ UnparsedFields → UnparsedFields → Bool Source # (>=) ∷ UnparsedFields → UnparsedFields → Bool Source # max ∷ UnparsedFields → UnparsedFields → UnparsedFields Source # min ∷ UnparsedFields → UnparsedFields → UnparsedFields Source #
HeapWords UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods heapWords ∷ UnparsedFields → Int Source #
NoThunks UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods noThunks ∷ Context → UnparsedFields → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → UnparsedFields → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy UnparsedFields → String Source #
type Rep UnparsedFields Source #
Instance details Defined in Cardano.Chain.Common.Attributes type Rep UnparsedFields = D1 ('MetaData "UnparsedFields" "Cardano.Chain.Common.Attributes" "cardano-ledger-byron-1.0.1.0-inplace" 'True) (C1 ('MetaCons "UnparsedFields" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Word8 ByteString))))

data Attributes h Source #

Convenient wrapper for the datatype to represent it (in binary format) as k-v map

Constructors

Attributes
Fields attrData ∷ !h Data, containing known keys (deserialized) attrRemain ∷ !UnparsedFields Remaining, unparsed fields

Instances

Instances details

ToJSON a ⇒ ToJSON (Attributes a) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods toJSON ∷ Attributes a → Value Source # toEncoding ∷ Attributes a → Encoding Source # toJSONList ∷ [Attributes a] → Value Source # toEncodingList ∷ [Attributes a] → Encoding Source # omitField ∷ Attributes a → Bool Source #
Generic (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Associated Types type Rep (Attributes h) ∷ Type → Type Source # Methods from ∷ Attributes h → Rep (Attributes h) x Source # to ∷ Rep (Attributes h) x → Attributes h Source #
Show h ⇒ Show (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods showsPrec ∷ Int → Attributes h → ShowS Source # show ∷ Attributes h → String Source # showList ∷ [Attributes h] → ShowS Source #
FromCBOR (Attributes AddrAttributes) Source #
Instance details Defined in Cardano.Chain.Common.AddrAttributes Methods fromCBOR ∷ Decoder s (Attributes AddrAttributes) Source # label ∷ Proxy (Attributes AddrAttributes) → Text Source #
FromCBOR (Attributes ()) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods fromCBOR ∷ Decoder s (Attributes ()) Source # label ∷ Proxy (Attributes ()) → Text Source #
ToCBOR (Attributes AddrAttributes) Source #
Instance details Defined in Cardano.Chain.Common.AddrAttributes Methods toCBOR ∷ Attributes AddrAttributes → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Attributes AddrAttributes) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Attributes AddrAttributes] → Size Source #
ToCBOR (Attributes ()) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods toCBOR ∷ Attributes () → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Attributes ()) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Attributes ()] → Size Source #
DecCBOR (Attributes AddrAttributes) Source #
Instance details Defined in Cardano.Chain.Common.AddrAttributes Methods decCBOR ∷ Decoder s (Attributes AddrAttributes) Source # dropCBOR ∷ Proxy (Attributes AddrAttributes) → Decoder s () Source # label ∷ Proxy (Attributes AddrAttributes) → Text Source #
DecCBOR (Attributes ()) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods decCBOR ∷ Decoder s (Attributes ()) Source # dropCBOR ∷ Proxy (Attributes ()) → Decoder s () Source # label ∷ Proxy (Attributes ()) → Text Source #
EncCBOR (Attributes AddrAttributes) Source #
Instance details Defined in Cardano.Chain.Common.AddrAttributes Methods encCBOR ∷ Attributes AddrAttributes → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Attributes AddrAttributes) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Attributes AddrAttributes] → Size Source #
EncCBOR (Attributes ()) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods encCBOR ∷ Attributes () → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Attributes ()) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Attributes ()] → Size Source #
NFData h ⇒ NFData (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods rnf ∷ Attributes h → () Source #
Buildable (Attributes ()) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods build ∷ Attributes () → Builder Source #
Buildable h ⇒ Buildable (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods build ∷ Attributes h → Builder Source #
Eq h ⇒ Eq (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods (==) ∷ Attributes h → Attributes h → Bool Source # (/=) ∷ Attributes h → Attributes h → Bool Source #
Ord h ⇒ Ord (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods compare ∷ Attributes h → Attributes h → Ordering Source # (<) ∷ Attributes h → Attributes h → Bool Source # (<=) ∷ Attributes h → Attributes h → Bool Source # (>) ∷ Attributes h → Attributes h → Bool Source # (>=) ∷ Attributes h → Attributes h → Bool Source # max ∷ Attributes h → Attributes h → Attributes h Source # min ∷ Attributes h → Attributes h → Attributes h Source #
HeapWords h ⇒ HeapWords (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods heapWords ∷ Attributes h → Int Source #
NoThunks h ⇒ NoThunks (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes Methods noThunks ∷ Context → Attributes h → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Attributes h → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Attributes h) → String Source #
type Rep (Attributes h) Source #
Instance details Defined in Cardano.Chain.Common.Attributes type Rep (Attributes h) = D1 ('MetaData "Attributes" "Cardano.Chain.Common.Attributes" "cardano-ledger-byron-1.0.1.0-inplace" 'False) (C1 ('MetaCons "Attributes" 'PrefixI 'True) (S1 ('MetaSel ('Just "attrData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 h) :*: S1 ('MetaSel ('Just "attrRemain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UnparsedFields)))

attributesAreKnown ∷ Attributes a → Bool Source #

Check whether all data from Attributes is known, i. e. was successfully parsed into some structured data

unknownAttributesLength ∷ Attributes a → Int Source #

encCBORAttributes ∷ ∀ t. [(Word8, t → ByteString)] → Attributes t → Encoding Source #

decCBORAttributes ∷ ∀ t s. t → (Word8 → ByteString → t → Decoder s (Maybe t)) → Decoder s (Attributes t) Source #

mkAttributes ∷ h → Attributes h Source #

dropAttributes ∷ Dropper s Source #

dropEmptyAttributes ∷ Dropper s Source #

Drop `Attributes ()` making sure that the UnparsedFields are empty