Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Serialization

Synopsis

class Typeable a => ToCBORGroup a where
- toCBORGroup :: a -> Encoding
- encodedGroupSizeExpr :: ( forall x. ToCBOR x => Proxy x -> Size ) -> Proxy a -> Size
- listLen :: a -> Word
- listLenBound :: Proxy a -> Word
class Typeable a => FromCBORGroup a where
- fromCBORGroup :: Decoder s a
newtype CBORGroup a = CBORGroup {
- unCBORGroup :: a
}
newtype CborSeq a = CborSeq {
- unwrapCborSeq :: Seq a
}
decodeList :: Decoder s a -> Decoder s [a]
decodeSeq :: Decoder s a -> Decoder s ( Seq a)
decodeStrictSeq :: Decoder s a -> Decoder s ( StrictSeq a)
decodeSet :: Ord a => Decoder s a -> Decoder s ( Set a)
decodeMap :: Ord a => Decoder s a -> Decoder s b -> Decoder s ( Map a b)
decodeMapContents :: Decoder s a -> Decoder s [a]
decodeMapTraverse :: ( Ord a, Applicative t) => Decoder s (t a) -> Decoder s (t b) -> Decoder s (t ( Map a b))
decodeMaybe :: Decoder s a -> Decoder s ( Maybe a)
decodeRecordNamed :: Text -> (a -> Int ) -> Decoder s a -> Decoder s a
decodeRecordNamedT :: ( MonadTrans m, Monad (m ( Decoder s))) => Text -> (a -> Int ) -> m ( Decoder s) a -> m ( Decoder s) a
decodeRecordSum :: String -> ( Word -> Decoder s ( Int , a)) -> Decoder s a
decodeNullMaybe :: Decoder s a -> Decoder s ( Maybe a)
encodeFoldable :: ( ToCBOR a, Foldable f) => f a -> Encoding
encodeFoldableEncoder :: Foldable f => (a -> Encoding ) -> f a -> Encoding
encodeFoldableMapEncoder :: Foldable f => ( Word -> a -> Maybe Encoding ) -> f a -> Encoding
encodeNullMaybe :: (a -> Encoding ) -> Maybe a -> Encoding
encodeMap :: (a -> Encoding ) -> (b -> Encoding ) -> Map a b -> Encoding
groupRecord :: forall a s. ( ToCBORGroup a, FromCBORGroup a) => Decoder s a
ratioToCBOR :: ToCBOR a => Ratio a -> Encoding
ratioFromCBOR :: ( Bounded a, Integral a, FromCBOR a) => Decoder s ( Ratio a)
mapToCBOR :: ( ToCBOR a, ToCBOR b) => Map a b -> Encoding
mapFromCBOR :: ( Ord a, FromCBOR a, FromCBOR b) => Decoder s ( Map a b)
translateViaCBORAnn :: ( ToCBOR a, FromCBOR ( Annotator b)) => Text -> a -> Except DecoderError b
ipv4ToBytes :: IPv4 -> ByteString
ipv4FromBytes :: ByteString -> Either String IPv4
ipv4ToCBOR :: IPv4 -> Encoding
ipv4FromCBOR :: Decoder s IPv4
ipv6ToBytes :: IPv6 -> ByteString
ipv6FromBytes :: ByteString -> Either String IPv6
ipv6ToCBOR :: IPv6 -> Encoding
ipv6FromCBOR :: Decoder s IPv6
listLenInt :: ToCBORGroup a => a -> Int
runByteBuilder :: Int -> Builder -> ByteString
utcTimeToCBOR :: UTCTime -> Encoding
utcTimeFromCBOR :: Decoder s UTCTime
data Sized a = Sized {
- sizedValue :: !a
- sizedSize :: Int64
}
mkSized :: ToCBOR a => a -> Sized a
sizedDecoder :: Decoder s a -> Decoder s ( Sized a)

Documentation

class Typeable a => ToCBORGroup a where Source #

Methods

toCBORGroup :: a -> Encoding Source #

encodedGroupSizeExpr :: ( forall x. ToCBOR x => Proxy x -> Size ) -> Proxy a -> Size Source #

listLen :: a -> Word Source #

listLenBound :: Proxy a -> Word Source #

an upper bound for listLen , used in Size expressions.

Instances

Instances details

ToCBORGroup ProtVer Source #
Instance details Defined in Cardano.Ledger.BaseTypes Methods toCBORGroup :: ProtVer -> Encoding Source # encodedGroupSizeExpr :: ( forall x. ToCBOR x => Proxy x -> Size ) -> Proxy ProtVer -> Size Source # listLen :: ProtVer -> Word Source # listLenBound :: Proxy ProtVer -> Word Source #
ToCBORGroup Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods toCBORGroup :: Ptr -> Encoding Source # encodedGroupSizeExpr :: ( forall x. ToCBOR x => Proxy x -> Size ) -> Proxy Ptr -> Size Source # listLen :: Ptr -> Word Source # listLenBound :: Proxy Ptr -> Word Source #

class Typeable a => FromCBORGroup a where Source #

Methods

fromCBORGroup :: Decoder s a Source #

Instances

Instances details

FromCBORGroup ProtVer Source #
Instance details Defined in Cardano.Ledger.BaseTypes Methods fromCBORGroup :: Decoder s ProtVer Source #
FromCBORGroup Ptr Source #
Instance details Defined in Cardano.Ledger.Credential Methods fromCBORGroup :: Decoder s Ptr Source #

newtype CBORGroup a Source #

Constructors

CBORGroup
Fields unCBORGroup :: a

Instances

Instances details

ToCBORGroup a => ToCBOR ( CBORGroup a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods toCBOR :: CBORGroup a -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( CBORGroup a) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ CBORGroup a] -> Size Source #
( FromCBORGroup a, ToCBORGroup a) => FromCBOR ( CBORGroup a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods fromCBOR :: Decoder s ( CBORGroup a) Source # label :: Proxy ( CBORGroup a) -> Text Source #

newtype CborSeq a Source #

Constructors

CborSeq
Fields unwrapCborSeq :: Seq a

Instances

Instances details

Foldable CborSeq Source #
Instance details Defined in Cardano.Ledger.Serialization Methods fold :: Monoid m => CborSeq m -> m Source # foldMap :: Monoid m => (a -> m) -> CborSeq a -> m Source # foldMap' :: Monoid m => (a -> m) -> CborSeq a -> m Source # foldr :: (a -> b -> b) -> b -> CborSeq a -> b Source # foldr' :: (a -> b -> b) -> b -> CborSeq a -> b Source # foldl :: (b -> a -> b) -> b -> CborSeq a -> b Source # foldl' :: (b -> a -> b) -> b -> CborSeq a -> b Source # foldr1 :: (a -> a -> a) -> CborSeq a -> a Source # foldl1 :: (a -> a -> a) -> CborSeq a -> a Source # toList :: CborSeq a -> [a] Source # null :: CborSeq a -> Bool Source # length :: CborSeq a -> Int Source # elem :: Eq a => a -> CborSeq a -> Bool Source # maximum :: Ord a => CborSeq a -> a Source # minimum :: Ord a => CborSeq a -> a Source # sum :: Num a => CborSeq a -> a Source # product :: Num a => CborSeq a -> a Source #
ToCBOR a => ToCBOR ( CborSeq a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods toCBOR :: CborSeq a -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( CborSeq a) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ CborSeq a] -> Size Source #
FromCBOR a => FromCBOR ( CborSeq a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods fromCBOR :: Decoder s ( CborSeq a) Source # label :: Proxy ( CborSeq a) -> Text Source #

decodeList :: Decoder s a -> Decoder s [a] Source #

decodeSeq :: Decoder s a -> Decoder s ( Seq a) Source #

decodeStrictSeq :: Decoder s a -> Decoder s ( StrictSeq a) Source #

decodeSet :: Ord a => Decoder s a -> Decoder s ( Set a) Source #

decodeMap :: Ord a => Decoder s a -> Decoder s b -> Decoder s ( Map a b) Source #

decodeMapContents :: Decoder s a -> Decoder s [a] Source #

decodeMapTraverse :: ( Ord a, Applicative t) => Decoder s (t a) -> Decoder s (t b) -> Decoder s (t ( Map a b)) Source #

decodeMaybe :: Decoder s a -> Decoder s ( Maybe a) Source #

decodeRecordNamed :: Text -> (a -> Int ) -> Decoder s a -> Decoder s a Source #

decodeRecordNamedT :: ( MonadTrans m, Monad (m ( Decoder s))) => Text -> (a -> Int ) -> m ( Decoder s) a -> m ( Decoder s) a Source #

decodeRecordSum :: String -> ( Word -> Decoder s ( Int , a)) -> Decoder s a Source #

decodeNullMaybe :: Decoder s a -> Decoder s ( Maybe a) Source #

encodeFoldable :: ( ToCBOR a, Foldable f) => f a -> Encoding Source #

encodeFoldableEncoder :: Foldable f => (a -> Encoding ) -> f a -> Encoding Source #

encodeFoldableMapEncoder :: Foldable f => ( Word -> a -> Maybe Encoding ) -> f a -> Encoding Source #

encodeNullMaybe :: (a -> Encoding ) -> Maybe a -> Encoding Source #

encodeMap :: (a -> Encoding ) -> (b -> Encoding ) -> Map a b -> Encoding Source #

groupRecord :: forall a s. ( ToCBORGroup a, FromCBORGroup a) => Decoder s a Source #

ratioToCBOR :: ToCBOR a => Ratio a -> Encoding Source #

ratioFromCBOR :: ( Bounded a, Integral a, FromCBOR a) => Decoder s ( Ratio a) Source #

mapToCBOR :: ( ToCBOR a, ToCBOR b) => Map a b -> Encoding Source #

mapFromCBOR :: ( Ord a, FromCBOR a, FromCBOR b) => Decoder s ( Map a b) Source #

translateViaCBORAnn :: ( ToCBOR a, FromCBOR ( Annotator b)) => Text -> a -> Except DecoderError b Source #

ipv4ToBytes :: IPv4 -> ByteString Source #

ipv4FromBytes :: ByteString -> Either String IPv4 Source #

ipv4ToCBOR :: IPv4 -> Encoding Source #

ipv4FromCBOR :: Decoder s IPv4 Source #

ipv6ToBytes :: IPv6 -> ByteString Source #

ipv6FromBytes :: ByteString -> Either String IPv6 Source #

ipv6ToCBOR :: IPv6 -> Encoding Source #

ipv6FromCBOR :: Decoder s IPv6 Source #

listLenInt :: ToCBORGroup a => a -> Int Source #

runByteBuilder :: Int -> Builder -> ByteString Source #

Run a ByteString Builder using a strategy aimed at making smaller things efficiently.

It takes a size hint and produces a strict ByteString . This will be fast when the size hint is the same or slightly bigger than the true size.

utcTimeToCBOR :: UTCTime -> Encoding Source #

utcTimeFromCBOR :: Decoder s UTCTime Source #

data Sized a Source #

A CBOR deserialized value together with its size. When deserializing use either sizedDecoder or its FromCBOR instance.

Use mkSized to construct such value.

Constructors

Sized
Fields sizedValue :: !a sizedSize :: Int64 Overhead in bytes. The field is lazy on purpose, because it might not be needed, but it can be expensive to compute.

Instances

Instances details

Eq a => Eq ( Sized a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods (==) :: Sized a -> Sized a -> Bool Source # (/=) :: Sized a -> Sized a -> Bool Source #
Show a => Show ( Sized a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods showsPrec :: Int -> Sized a -> ShowS Source # show :: Sized a -> String Source # showList :: [ Sized a] -> ShowS Source #
Generic ( Sized a) Source #
Instance details Defined in Cardano.Ledger.Serialization Associated Types type Rep ( Sized a) :: Type -> Type Source # Methods from :: Sized a -> Rep ( Sized a) x Source # to :: Rep ( Sized a) x -> Sized a Source #
ToCBOR a => ToCBOR ( Sized a) Source #	Discards the size.
Instance details Defined in Cardano.Ledger.Serialization Methods toCBOR :: Sized a -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( Sized a) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Sized a] -> Size Source #
FromCBOR a => FromCBOR ( Sized a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods fromCBOR :: Decoder s ( Sized a) Source # label :: Proxy ( Sized a) -> Text Source #
NoThunks a => NoThunks ( Sized a) Source #
Instance details Defined in Cardano.Ledger.Serialization Methods noThunks :: Context -> Sized a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Sized a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( Sized a) -> String Source #
type Rep ( Sized a) Source #
Instance details Defined in Cardano.Ledger.Serialization type Rep ( Sized a) = D1 (' MetaData "Sized" "Cardano.Ledger.Serialization" "cardano-ledger-core-0.1.0.0-3EJt5rxsPizAWHDEqGPh9V" ' False ) ( C1 (' MetaCons "Sized" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "sizedValue") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a) :*: S1 (' MetaSel (' Just "sizedSize") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int64 )))

mkSized :: ToCBOR a => a -> Sized a Source #

Construct a Sized value by serializing it first and recording the amount of bytes it requires. Note, however, CBOR serialization is not canonical, therefore it is *NOT* a requirement that this property holds:

sizedSize (mkSized a) === sizedSize (unsafeDeserialize (serialize a) :: a)

sizedDecoder :: Decoder s a -> Decoder s ( Sized a) Source #