Moduleautodocodec-0.5.0.0Haskell2010

Autodocodec.Class

2 classes
14 values

Packageautodocodec-0.5.0.0
Exports16
LanguageHaskell2010
LicenceMIT
SourceClass.hs

classclass HasCodec value where

A class for values which have a canonical codec.

There are no formal laws for this class. If you really want a law, it should be "Whomever uses the codec from your instance should not be surprised."

Methods

codec :: JSONCodec value
A codec for a single value
See the sections on helper functions for implementing this for plenty of examples.
listCodecForStringCompatibility :: JSONCodec [value]
A codec for a list of values
This is really only useful for cases like Char and String. We didn't call it listCodec so we could use that name for making a codec for a list of values from a single codec instead.

Instances45HasCodec, …

HasCodec ValueDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec IntegerDefined in autodocodec-0.5.0.0 · Autodocodec.Class
This instance uses the "safe" integerCodec.
HasCodec NaturalDefined in autodocodec-0.5.0.0 · Autodocodec.Class
This instance uses the "safe" naturalCodec.
HasCodec VoidDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Int16Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Int32Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Int64Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Int8Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Word16Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Word32Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Word64Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec Word8Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec BoolDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec CharDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec IntDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec OrderingDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec WordDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec ScientificDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec TextDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec TextDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec DayDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec DiffTimeDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec NominalDiffTimeDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec UTCTimeDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec LocalTimeDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec TimeOfDayDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec ZonedTimeDefined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (First a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Last a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (DNonEmpty a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (DList a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (NonEmpty a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Identity a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (First a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Last a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Dual a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Maybe a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Vector a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec [a]Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec v => HasCodec (KeyMap v)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
(Ord a, HasCodec a) => HasCodec (Set a)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
(HasCodec l, HasCodec r) => HasCodec (Either l r)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
(Eq k, Hashable k, FromJSONKey k, ToJSONKey k, HasCodec v) => HasCodec (HashMap k v)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
(Ord k, FromJSONKey k, ToJSONKey k, HasCodec v) => HasCodec (Map k v)Defined in autodocodec-0.5.0.0 · Autodocodec.Class
HasCodec a => HasCodec (Const a b)Defined in autodocodec-0.5.0.0 · Autodocodec.Class

classclass HasObjectCodec object where

A class for values which have a canonical object codec.

There are no formal laws for this class. If you really want a law, it should be "Whomever uses the codec from your instance should not be surprised."

Methods

objectCodec :: JSONObjectCodec object
A object codec for the value
See the sections on helper functions for implementing this for plenty of examples.

valuerequiredField

:: HasCodec output
=> Text
Key
-> Text
Documentation
-> ObjectCodec output output

A required field

During decoding, the field must be in the object.

During encoding, the field will always be in the object.

See requiredFieldWith

valuerequiredField'

:: HasCodec output
=> Text
Key
-> ObjectCodec output output

Like requiredField, but without documentation

valueoptionalField

:: HasCodec output
=> Text
Key
-> Text
Documentation
-> ObjectCodec (Maybe output) (Maybe output)

An optional field

During decoding, the field may be in the object. Nothing will be parsed otherwise.

During encoding, the field will be in the object if it is not Nothing, and omitted otherwise.

See optionalFieldWith

valueoptionalField'

:: HasCodec output
=> Text
Key
-> ObjectCodec (Maybe output) (Maybe output)

Like optionalField, but without documentation

valueoptionalFieldWithDefault

:: HasCodec output
=> Text
Key
-> output
Default value
-> Text
Documentation
-> ObjectCodec output output

An optional field with a default value

During decoding, the field may be in the object. The default value will be parsed otherwise.

During encoding, the field will be in the object. The default value is ignored.

The shown version of the default value will appear in the documentation.

valueoptionalFieldWithDefault'

:: HasCodec output
=> Text
Key
-> output
Default value
-> ObjectCodec output output

Like optionalFieldWithDefault, but without documentation

valueoptionalFieldOrNullWithDefault

:: (Eq output, HasCodec output)
=> Text
Key
-> output
Default value
-> Text
Documentation
-> ObjectCodec output output

Like optionalFieldOrNull, but also interpret null as the default value.

valueoptionalFieldOrNullWithDefault'

:: (Eq output, HasCodec output)
=> Text
Key
-> output
Default value
-> ObjectCodec output output

Like optionalFieldOrNullWithDefault, but without documentation

valueoptionalFieldOrNull

:: HasCodec output
=> Text
Key
-> Text
Documentation
-> ObjectCodec (Maybe output) (Maybe output)

An optional, or null, field

During decoding, the field may be in the object. Nothing will be parsed if it is not. If the field is null, then it will be parsed as Nothing as well.

During encoding, the field will be in the object if it is not Nothing, and omitted otherwise.

valueoptionalFieldOrNull'

:: HasCodec output
=> Text
Key
-> ObjectCodec (Maybe output) (Maybe output)

Like optionalFieldOrNull, but without documentation

valueoptionalFieldWithOmittedDefault

:: (Eq output, HasCodec output)
=> Text
Key
-> output
Default value
-> Text
Documentation
-> ObjectCodec output output

valueoptionalFieldWithOmittedDefault'

:: (Eq output, HasCodec output)
=> Text
Key
-> output
Default value
-> ObjectCodec output output

valueoptionalFieldOrNullWithOmittedDefault

:: (Eq output, HasCodec output)
=> Text
Key
-> output
Default value
-> Text
Documentation
-> ObjectCodec output output

valueoptionalFieldOrNullWithOmittedDefault'

:: (Eq output, HasCodec output)
=> Text
Key
-> output
Default value
-> ObjectCodec output output