Waargonaut.Encode.Types

Types and functions that make up the internal structure of the encoders.

Types

data EncoderFns i f a

Define an "encoder" as a function from some a to some Json with the allowance for some context f.

The helper functions jsonEncoder and objEncoder are probably what you want to use.

Constructors

EncoderFns

Fields

• finaliseEncoding :: i -> Json

  The i need not be the final Json structure. This function will complete the output from initialEncoding to the final Json output.

• initialEncoding :: a -> f i

  Run the initial encoding step of the given input. This lets you encode the a to an intermediate structure before utilising the finaliseEncoding function to complete the process.

Instances

MFunctor (EncoderFns i :: (Type -> Type) -> Type -> Type)

Defined in Waargonaut.Encode.Types

Methods

hoist :: Monad m => (forall a. m a -> n a) -> EncoderFns i m b -> EncoderFns i n b

Contravariant (EncoderFns o f)

Defined in Waargonaut.Encode.Types

Methods

contramap :: (a -> b) -> EncoderFns o f b -> EncoderFns o f a

(>$) :: b -> EncoderFns o f b -> EncoderFns o f a

Applicative f => Divisible (EncoderFns (JObject WS Json) f)

Defined in Waargonaut.Encode.Types

Methods

divide :: (a -> (b, c)) -> EncoderFns (JObject WS Json) f b -> EncoderFns (JObject WS Json) f c -> EncoderFns (JObject WS Json) f a

conquer :: EncoderFns (JObject WS Json) f a

Applicative f => Decidable (EncoderFns (JObject WS Json) f)

Defined in Waargonaut.Encode.Types

Methods

lose :: (a -> Void) -> EncoderFns (JObject WS Json) f a

choose :: (a -> Either b c) -> EncoderFns (JObject WS Json) f b -> EncoderFns (JObject WS Json) f c -> EncoderFns (JObject WS Json) f a

Useful aliases

type Encoder f a = EncoderFns Json f a

As a convenience, this type defines the i to be a specific Json structure:

type Encoder' a = EncoderFns Json Identity a

As a convenience, this type is a pure Encoder over Identity in place of the f.

type ObjEncoder f a = EncoderFns (JObject WS Json) f a

As a convenience, this type defines the i to be a specific 'JObject WS Json' structure:

type ObjEncoder' a = EncoderFns (JObject WS Json) Identity a

As a convenience, this type is a pure ObjEncoder over Identity in place of the f.

Runners

runEncoder :: Functor f => EncoderFns i f a -> a -> f Json

Run any encoder to the Json representation, allowing for some Functor context f.

runPureEncoder :: EncoderFns i Identity a -> a -> Json

Run any encoder to the Json representation, with the context specialised to Identity for convenience.

Helpers

jsonEncoder :: (a -> f Json) -> EncoderFns Json f a

Helper function for creating an Encoder, provides the default finaliseEncoding function for Json encoders.

objEncoder :: (a -> f (JObject WS Json)) -> EncoderFns (JObject WS Json) f a

Helper function for creating a JSON object Encoder. Provides the default finaliseEncoding function for completing the JObject to the necessary Json type.

generaliseEncoder :: Monad f => EncoderFns i Identity a -> EncoderFns i f a

Generalise any Encoder a' to 'Encoder f a'