Copyright	(c) 2018-2022 Tim Emiola
License	BSD3
Maintainer	Tim Emiola <tim@emio.la>
Safe Haskell	Safe-Inferred
Language	Haskell2010

KeyedVals.Handle.Codec

Contents

decode/encode support
decode encoded ValsByKey
save encoded ValsByKey using a Handle
error conversion

Description

Provides a typeclass that converts types to and from keys or vals and combinators that help it to encode data using Handle

This serves to decouple the encoding/decoding, making it straightforward to use the typed interface in Typed with a wide set of encoding/decoding schemes

Synopsis

class EncodeKV a where
- encodeKV :: a -> Val
class DecodeKV a where
- decodeKV :: Val -> Either Text a
decodeOr :: (DecodeKV a, FromHandleErr err) => Maybe Val -> Either err (Maybe a)
decodeOr' :: (DecodeKV b, FromHandleErr err) => Either err (Maybe Val) -> Either err (Maybe b)
decodeOrGone :: (DecodeKV b, FromHandleErr err) => Key -> Maybe Val -> Either err b
decodeOrGone' :: (DecodeKV b, FromHandleErr err) => Key -> Either err (Maybe Val) -> Either err b
decodeKVs :: (Ord a, DecodeKV a, DecodeKV b, FromHandleErr err) => ValsByKey -> Either err (Map a b)
saveEncodedKVs :: (Ord a, EncodeKV a, EncodeKV b, Monad m, FromHandleErr err) => Handle m -> Key -> Map a b -> m (Either err ())
updateEncodedKVs :: (Ord a, EncodeKV a, EncodeKV b, Monad m, FromHandleErr err) => Handle m -> Key -> Map a b -> m (Either err ())
class FromHandleErr err where
- fromHandleErr :: HandleErr -> err

decode/encode support

class EncodeKV a where Source #

Specifies how type a encodes as a Key or a Val.

Methods

encodeKV :: a -> Val Source #

Instances

Instances details

ToJSON a => EncodeKV (AesonOf a) Source #
Instance details Defined in KeyedVals.Handle.Codec.Aeson Methods encodeKV :: AesonOf a -> Val Source #
ToHttpApiData a => EncodeKV (HttpApiDataOf a) Source #
Instance details Defined in KeyedVals.Handle.Codec.HttpApiData Methods encodeKV :: HttpApiDataOf a -> Val Source #
EncodeKV (TypedKey v) Source #
Instance details Defined in KeyedVals.Handle.Typed Methods encodeKV :: TypedKey v -> Val Source #

class DecodeKV a where Source #

Specifies how type a can be decoded from a Key or a Val.

Methods

decodeKV :: Val -> Either Text a Source #

Instances

Instances details

FromJSON a => DecodeKV (AesonOf a) Source #
Instance details Defined in KeyedVals.Handle.Codec.Aeson Methods decodeKV :: Val -> Either Text (AesonOf a) Source #
FromHttpApiData a => DecodeKV (HttpApiDataOf a) Source #
Instance details Defined in KeyedVals.Handle.Codec.HttpApiData Methods decodeKV :: Val -> Either Text (HttpApiDataOf a) Source #