Module

Data.Codec

Package: purescript-codec
Repository: garyb/purescript-codec

#GCodec Source

data GCodec :: (Type -> Type) -> (Type -> Type) -> Type -> Type -> Typedata GCodec m n a b

A general type for codecs.

Constructors

GCodec (m b) (Star n a b)

Instances

(Functor m, Functor n) => Functor (GCodec m n a)
(Functor m, Functor n) => Invariant (GCodec m n a)
(Apply m, Apply n) => Apply (GCodec m n a)
(Applicative m, Applicative n) => Applicative (GCodec m n a)
(Bind m, Bind n) => Bind (GCodec m n a)
(Monad m, Monad n) => Monad (GCodec m n a)
(Functor m, Functor n) => Profunctor (GCodec m n)
(Alt m, Alt n) => Alt (GCodec m n a)
(Plus m, Plus n) => Plus (GCodec m n a)
(Alternative m, Alternative n) => Alternative (GCodec m n a)
(MonadPlus m, MonadPlus n) => MonadPlus (GCodec m n a)
(Bind n) => Semigroupoid (GCodec m n)

#decoder Source

decoder :: forall m n a b. GCodec m n a b -> m b

Extracts the decoder part of a GCodec

#encoder Source

encoder :: forall m n a b. GCodec m n a b -> Star n a b

Extracts the encoder part of a GCodec

#bihoistGCodec Source

bihoistGCodec :: forall m m' n n' a b. (m ~> m') -> (n ~> n') -> GCodec m n a b -> GCodec m' n' a b

Changes the m and n functors used in the codec using the specified natural transformations.

#(~) Source

Operator alias for Data.Profunctor.lcmap (left-associative / precedence 5)

GCodec is defined as a Profunctor so that lcmap can be used to target specific fields when defining a codec for a product type. This operator is a convenience for that:

tupleCodec =
  Tuple
    <$> fst ~ fstCodec
    <*> snd ~ sndCodec

#Codec Source

type Codec :: (Type -> Type) -> Type -> Type -> Type -> Type -> Typetype Codec m a b c d = GCodec (ReaderT a m) (Writer b) c d

#codec Source

codec :: forall m a b c d. (a -> m d) -> (c -> Tuple d b) -> Codec m a b c d

#decode Source

decode :: forall m a b c d. Codec m a b c d -> a -> m d

#encode Source

encode :: forall m a b c d. Codec m a b c d -> c -> b

#mapCodec Source

mapCodec :: forall m a b c d. Bind m => (a -> m b) -> (b -> a) -> Codec m c d a a -> Codec m c d b b

#composeCodec Source

composeCodec :: forall a d f b e c m. Bind m => Codec m d c e f -> Codec m a b c d -> Codec m a b e f

#(<~<) Source

Operator alias for Data.Codec.composeCodec (right-associative / precedence 8)

#composeCodecFlipped Source

composeCodecFlipped :: forall a d f b e c m. Bind m => Codec m a b c d -> Codec m d c e f -> Codec m a b e f

#(>~>) Source

Operator alias for Data.Codec.composeCodecFlipped (right-associative / precedence 8)

#hoistCodec Source

hoistCodec :: forall m m' a b c d. (m ~> m') -> Codec m a b c d -> Codec m' a b c d

#BasicCodec Source

type BasicCodec :: (Type -> Type) -> Type -> Type -> Typetype BasicCodec m a b = Codec m a a b b

#basicCodec Source

basicCodec :: forall m a b. (a -> m b) -> (b -> a) -> BasicCodec m a b

Modules: Data.Codec