Data.Name.JSON

This module provides a JSONStyle Named style that can be used for JSON encoding/decoding. It also provides conversion to and from that style from the regular UTF8 style, as well as an "aeson" ToJSON and FromJSON instance.

Documentation

type JSONStyle = "JSON" :: NameStyle

The JSONStyle of Named objects can be directly transformed to and from JSON (via Aeson's ToJSON and FromJSON classes). The Named nameOf is not represented in the JSON form; field names are expected to be provided by the Named field name itself. Bi-directional conversions between the JSON style and the UTF8 style is automatic.

Orphan instances

NameText JSONStyle

Methods

nameText :: forall (nm :: Symbol). Named JSONStyle nm -> Text

ConvertNameStyle CaseInsensitive JSONStyle nameOf

Methods

convertStyle :: Named CaseInsensitive nameOf -> Named JSONStyle nameOf

ConvertNameStyle UTF8 JSONStyle nameOf

Methods

convertStyle :: Named UTF8 nameOf -> Named JSONStyle nameOf

ConvertNameStyle JSONStyle CaseInsensitive nameOf

Methods

convertStyle :: Named JSONStyle nameOf -> Named CaseInsensitive nameOf

ConvertNameStyle JSONStyle UTF8 nameOf

Methods

convertStyle :: Named JSONStyle nameOf -> Named UTF8 nameOf

FromJSON (Name nameTy)

Methods

parseJSON :: Value -> Parser (Name nameTy)

parseJSONList :: Value -> Parser [Name nameTy]

FromJSONKey (Name nameTy)

Methods

fromJSONKey :: FromJSONKeyFunction (Name nameTy)

fromJSONKeyList :: FromJSONKeyFunction [Name nameTy]

ToJSON (Name nameTy)

Methods

toJSON :: Name nameTy -> Value

toEncoding :: Name nameTy -> Encoding

toJSONList :: [Name nameTy] -> Value

toEncodingList :: [Name nameTy] -> Encoding

ToJSONKey (Name nameTy)

Methods

toJSONKey :: ToJSONKeyFunction (Name nameTy)

toJSONKeyList :: ToJSONKeyFunction [Name nameTy]

FromJSON (Named CaseInsensitive nameTy)

Methods

parseJSON :: Value -> Parser (Named CaseInsensitive nameTy)

parseJSONList :: Value -> Parser [Named CaseInsensitive nameTy]

FromJSON (Named JSONStyle nameTy)

Methods

parseJSON :: Value -> Parser (Named JSONStyle nameTy)

parseJSONList :: Value -> Parser [Named JSONStyle nameTy]

FromJSONKey (Named CaseInsensitive nameTy)

Methods

fromJSONKey :: FromJSONKeyFunction (Named CaseInsensitive nameTy)

fromJSONKeyList :: FromJSONKeyFunction [Named CaseInsensitive nameTy]

FromJSONKey (Named JSONStyle nameTy)

Methods

fromJSONKey :: FromJSONKeyFunction (Named JSONStyle nameTy)

fromJSONKeyList :: FromJSONKeyFunction [Named JSONStyle nameTy]

ToJSON (Named CaseInsensitive nameTy)

Methods

toJSON :: Named CaseInsensitive nameTy -> Value

toEncoding :: Named CaseInsensitive nameTy -> Encoding

toJSONList :: [Named CaseInsensitive nameTy] -> Value

toEncodingList :: [Named CaseInsensitive nameTy] -> Encoding

ToJSON (Named JSONStyle nameTy)

Methods

toJSON :: Named JSONStyle nameTy -> Value

toEncoding :: Named JSONStyle nameTy -> Encoding

toJSONList :: [Named JSONStyle nameTy] -> Value

toEncodingList :: [Named JSONStyle nameTy] -> Encoding

ToJSONKey (Named CaseInsensitive nameTy)

Methods

toJSONKey :: ToJSONKeyFunction (Named CaseInsensitive nameTy)

toJSONKeyList :: ToJSONKeyFunction [Named CaseInsensitive nameTy]

ToJSONKey (Named JSONStyle nameTy)

Methods

toJSONKey :: ToJSONKeyFunction (Named JSONStyle nameTy)

toJSONKeyList :: ToJSONKeyFunction [Named JSONStyle nameTy]