KeyedVals.Handle.Codec

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

decode/encode support

class EncodeKV a where

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

Methods

encodeKV :: a -> Val

Instances

ToJSON a => EncodeKV (AesonOf a)

Defined in KeyedVals.Handle.Codec.Aeson

Methods

encodeKV :: AesonOf a -> Val

ToHttpApiData a => EncodeKV (HttpApiDataOf a)

Defined in KeyedVals.Handle.Codec.HttpApiData

Methods

encodeKV :: HttpApiDataOf a -> Val

EncodeKV (TypedKey v)

Defined in KeyedVals.Handle.Typed

Methods

encodeKV :: TypedKey v -> Val

class DecodeKV a where

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

Methods

decodeKV :: Val -> Either Text a

Instances

FromJSON a => DecodeKV (AesonOf a)

Defined in KeyedVals.Handle.Codec.Aeson

Methods

decodeKV :: Val -> Either Text (AesonOf a)

FromHttpApiData a => DecodeKV (HttpApiDataOf a)

Defined in KeyedVals.Handle.Codec.HttpApiData

Methods

decodeKV :: Val -> Either Text (HttpApiDataOf a)

decodeOr :: (DecodeKV a, FromHandleErr err) => Maybe Val -> Either err (Maybe a)

Decode a value, transforming decode errors to type err.

decodeOr' :: (DecodeKV b, FromHandleErr err) => Either err (Maybe Val) -> Either err (Maybe b)

Decode a value, transformi decode errors to type err.

decodeOrGone :: (DecodeKV b, FromHandleErr err) => Key -> Maybe Val -> Either err b

Like decodeOr, but transforms Nothing to Gone.

decodeOrGone' :: (DecodeKV b, FromHandleErr err) => Key -> Either err (Maybe Val) -> Either err b

Like decodeOr', but transforms Nothing to Gone.

decode encoded ValsByKey

decodeKVs :: (Ord a, DecodeKV a, DecodeKV b, FromHandleErr err) => ValsByKey -> Either err (Map a b)

Decodes a Map from a ValsByKey with encoded Keys and Vals.

save encoded ValsByKey using a Handle

saveEncodedKVs :: (Ord a, EncodeKV a, EncodeKV b, Monad m, FromHandleErr err) => Handle m -> Key -> Map a b -> m (Either err ())

Encode a Map as a ValsByKey with the Keys and Vals encoded.

• HandleErr may be transformed to different error type

updateEncodedKVs :: (Ord a, EncodeKV a, EncodeKV b, Monad m, FromHandleErr err) => Handle m -> Key -> Map a b -> m (Either err ())

Like saveEncodedKVs, but updates the keys rather than completely replacing it.

error conversion

class FromHandleErr err where

Specifies how to turn HandleErr into a custom error type err.

Methods

fromHandleErr :: HandleErr -> err

Instances

FromHandleErr HandleErr

Defined in KeyedVals.Handle.Codec

Methods

fromHandleErr :: HandleErr -> HandleErr