-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Extra goodies for aeson
--   
--   Package provides extra funcitonality on top of <tt>aeson</tt> and
--   <tt>aeson-compat</tt>
@package aeson-extra
@version 0.3.0.0


-- | More or less useful newtypes for writing <a>FromJSON</a> &amp;
--   <a>ToJSON</a> instances
module Data.Aeson.Extra

-- | Like <a>encode</a>, but produces strict <a>ByteString</a>.
--   
--   <i>Since: 0.2.3.0</i>
encodeStrict :: ToJSON a => a -> ByteString

-- | A wrapper type to parse arbitrary maps
--   
--   <pre>
--   λ &gt; decode "{\"1\": 1, \"2\": 2}" :: Maybe (M (H.HashMap Int Int))
--   Just (M {getMap = fromList [(1,1),(2,2)]})
--   </pre>
newtype M a
M :: a -> M a
[getMap] :: M a -> a
class FromJSONKey a
parseJSONKey :: FromJSONKey a => Text -> Parser a
parseIntegralJSONKey :: Integral a => Text -> Parser a
class FromJSONMap m k v | m -> k v
parseJSONMap :: FromJSONMap m k v => HashMap Text Value -> Parser m
class ToJSONKey a
toJSONKey :: ToJSONKey a => a -> Text
class ToJSONMap m k v | m -> k v
toJSONMap :: ToJSONMap m k v => m -> HashMap Text Value

-- | Singleton string encoded and decoded as ifself.
--   
--   <pre>
--   λ&gt; encode (SymTag :: SymTag "foobar")
--   "\"foobar\""
--   </pre>
--   
--   <pre>
--   decode "\"foobar\"" :: Maybe (SymTag "foobar")
--   Just SymTag
--   </pre>
--   
--   <pre>
--   decode "\"foobar\"" :: Maybe (SymTag "barfoo")
--   Nothing
--   </pre>
--   
--   <i>Available with: base &gt;=4.7</i>
data SymTag (s :: Symbol)
SymTag :: SymTag

-- | Singleton value object
--   
--   <pre>
--   λ &gt; decode "{\"value\": 42 }" :: Maybe (SingObject "value" Int)
--   Just (SingObject 42)
--   </pre>
--   
--   <pre>
--   λ &gt; encode (SingObject 42 :: SingObject "value" Int)
--   "{\"value\":42}"
--   </pre>
--   
--   <i>Available with: base &gt;=4.7</i>
newtype SingObject (s :: Symbol) a
SingObject :: a -> SingObject a
mkSingObject :: Proxy s -> a -> SingObject s a
getSingObject :: Proxy s -> SingObject s a -> a

-- | Collapsed list, singleton is represented as the value itself in JSON
--   encoding.
--   
--   <pre>
--   λ &gt; decode "null" :: Maybe (CollapsedList [Int] Int)
--   Just (CollapsedList [])
--   λ &gt; decode "42" :: Maybe (CollapsedList [Int] Int)
--   Just (CollapsedList [42])
--   λ &gt; decode "[1, 2, 3]" :: Maybe (CollapsedList [Int] Int)
--   Just (CollapsedList [1,2,3])
--   </pre>
--   
--   <pre>
--   λ &gt; encode (CollapsedList ([] :: [Int]))
--   "null"
--   λ &gt; encode (CollapsedList ([42] :: [Int]))
--   "42"
--   λ &gt; encode (CollapsedList ([1, 2, 3] :: [Int]))
--   "[1,2,3]"
--   </pre>
--   
--   Documentation rely on <tt>f</tt> <a>Alternative</a> instance behaving
--   like lists'.
newtype CollapsedList f a
CollapsedList :: (f a) -> CollapsedList f a
getCollapsedList :: CollapsedList f a -> f a

-- | Parses possibly collapsed array value from the object's field.
--   
--   <pre>
--   λ &gt; newtype V = V [Int] deriving (Show)
--   λ &gt; instance FromJSON V where parseJSON = withObject "V" $ \obj -&gt; V &lt;$&gt; parseCollapsedList obj "value"
--   λ &gt; decode "{}" :: Maybe V
--   Just (V [])
--   λ &gt; decode "{\"value\": null}" :: Maybe V
--   Just (V [])
--   λ &gt; decode "{\"value\": 42}" :: Maybe V
--   Just (V [42])
--   λ &gt; decode "{\"value\": [1, 2, 3, 4]}" :: Maybe V
--   Just (V [1,2,3,4])
--   </pre>
parseCollapsedList :: (FromJSON a, FromJSON (f a), Alternative f) => Object -> Text -> Parser (f a)

-- | A type to parse <a>UTCTime</a>
--   
--   <a>FromJSON</a> instance accepts for example:
--   
--   <pre>
--   2015-09-07T08:16:40.807Z
--   2015-09-07 11:16:40.807 +03:00
--   </pre>
--   
--   Latter format is accepted by <tt>aeson</tt> staring from version
--   <tt>0.10.0.0</tt>.
--   
--   See
--   <a>https://github.com/bos/aeson/blob/4667ef1029a373cf4510f7deca147c357c6d8947/Data/Aeson/Parser/Time.hs#L150</a>
--   
--   <i>Since: aeson-extra-0.2.2.0</i>
newtype U
U :: UTCTime -> U
[getU] :: U -> UTCTime

-- | A type to parse <a>ZonedTime</a>
--   
--   <i>Since: aeson-extra-0.2.2.0</i>
newtype Z
Z :: ZonedTime -> Z
[getZ] :: Z -> ZonedTime
instance GHC.Read.Read Data.Aeson.Extra.Z
instance GHC.Show.Show Data.Aeson.Extra.Z
instance GHC.Read.Read Data.Aeson.Extra.U
instance GHC.Show.Show Data.Aeson.Extra.U
instance GHC.Classes.Ord Data.Aeson.Extra.U
instance GHC.Classes.Eq Data.Aeson.Extra.U
instance Data.Traversable.Traversable f => Data.Traversable.Traversable (Data.Aeson.Extra.CollapsedList f)
instance Data.Foldable.Foldable f => Data.Foldable.Foldable (Data.Aeson.Extra.CollapsedList f)
instance GHC.Base.Functor f => GHC.Base.Functor (Data.Aeson.Extra.CollapsedList f)
instance GHC.Read.Read (f a) => GHC.Read.Read (Data.Aeson.Extra.CollapsedList f a)
instance GHC.Show.Show (f a) => GHC.Show.Show (Data.Aeson.Extra.CollapsedList f a)
instance GHC.Classes.Ord (f a) => GHC.Classes.Ord (Data.Aeson.Extra.CollapsedList f a)
instance GHC.Classes.Eq (f a) => GHC.Classes.Eq (Data.Aeson.Extra.CollapsedList f a)
instance Data.Traversable.Traversable (Data.Aeson.Extra.SingObject s)
instance Data.Foldable.Foldable (Data.Aeson.Extra.SingObject s)
instance GHC.Base.Functor (Data.Aeson.Extra.SingObject s)
instance GHC.Read.Read a => GHC.Read.Read (Data.Aeson.Extra.SingObject s a)
instance GHC.Show.Show a => GHC.Show.Show (Data.Aeson.Extra.SingObject s a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Data.Aeson.Extra.SingObject s a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Data.Aeson.Extra.SingObject s a)
instance GHC.Enum.Bounded (Data.Aeson.Extra.SymTag s)
instance GHC.Enum.Enum (Data.Aeson.Extra.SymTag s)
instance GHC.Read.Read (Data.Aeson.Extra.SymTag s)
instance GHC.Show.Show (Data.Aeson.Extra.SymTag s)
instance GHC.Classes.Ord (Data.Aeson.Extra.SymTag s)
instance GHC.Classes.Eq (Data.Aeson.Extra.SymTag s)
instance Data.Traversable.Traversable Data.Aeson.Extra.M
instance Data.Foldable.Foldable Data.Aeson.Extra.M
instance GHC.Base.Functor Data.Aeson.Extra.M
instance GHC.Read.Read a => GHC.Read.Read (Data.Aeson.Extra.M a)
instance GHC.Show.Show a => GHC.Show.Show (Data.Aeson.Extra.M a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Data.Aeson.Extra.M a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Data.Aeson.Extra.M a)
instance Data.Aeson.Extra.FromJSONKey Data.Text.Internal.Text
instance Data.Aeson.Extra.FromJSONKey Data.Text.Internal.Lazy.Text
instance Data.Aeson.Extra.FromJSONKey GHC.Base.String
instance Data.Aeson.Extra.FromJSONKey GHC.Types.Int
instance Data.Aeson.Extra.FromJSONKey GHC.Integer.Type.Integer
instance (GHC.Classes.Eq k, Data.Hashable.Class.Hashable k, Data.Aeson.Extra.FromJSONKey k, Data.Aeson.Types.Class.FromJSON v) => Data.Aeson.Extra.FromJSONMap (Data.HashMap.Base.HashMap k v) k v
instance (GHC.Classes.Ord k, Data.Aeson.Extra.FromJSONKey k, Data.Aeson.Types.Class.FromJSON v) => Data.Aeson.Extra.FromJSONMap (Data.Map.Base.Map k v) k v
instance Data.Aeson.Extra.FromJSONMap m k v => Data.Aeson.Types.Class.FromJSON (Data.Aeson.Extra.M m)
instance Data.Aeson.Extra.ToJSONKey Data.Text.Internal.Text
instance Data.Aeson.Extra.ToJSONKey Data.Text.Internal.Lazy.Text
instance Data.Aeson.Extra.ToJSONKey GHC.Base.String
instance Data.Aeson.Extra.ToJSONKey GHC.Types.Int
instance Data.Aeson.Extra.ToJSONKey GHC.Integer.Type.Integer
instance (Data.Aeson.Extra.ToJSONKey k, Data.Aeson.Types.Class.ToJSON v) => Data.Aeson.Extra.ToJSONMap (Data.HashMap.Base.HashMap k v) k v
instance (Data.Aeson.Extra.ToJSONKey k, Data.Aeson.Types.Class.ToJSON v) => Data.Aeson.Extra.ToJSONMap (Data.Map.Base.Map k v) k v
instance Data.Aeson.Extra.ToJSONMap m k v => Data.Aeson.Types.Class.ToJSON (Data.Aeson.Extra.M m)
instance GHC.TypeLits.KnownSymbol s => Data.Aeson.Types.Class.FromJSON (Data.Aeson.Extra.SymTag s)
instance GHC.TypeLits.KnownSymbol s => Data.Aeson.Types.Class.ToJSON (Data.Aeson.Extra.SymTag s)
instance (GHC.TypeLits.KnownSymbol s, Data.Aeson.Types.Class.FromJSON a) => Data.Aeson.Types.Class.FromJSON (Data.Aeson.Extra.SingObject s a)
instance (GHC.TypeLits.KnownSymbol s, Data.Aeson.Types.Class.ToJSON a) => Data.Aeson.Types.Class.ToJSON (Data.Aeson.Extra.SingObject s a)
instance (Data.Aeson.Types.Class.FromJSON a, Data.Aeson.Types.Class.FromJSON (f a), GHC.Base.Alternative f) => Data.Aeson.Types.Class.FromJSON (Data.Aeson.Extra.CollapsedList f a)
instance (Data.Aeson.Types.Class.ToJSON a, Data.Aeson.Types.Class.ToJSON (f a), Data.Foldable.Foldable f) => Data.Aeson.Types.Class.ToJSON (Data.Aeson.Extra.CollapsedList f a)
instance Data.Aeson.Types.Class.ToJSON Data.Aeson.Extra.U
instance Data.Aeson.Types.Class.FromJSON Data.Aeson.Extra.U
instance Data.Aeson.Types.Class.ToJSON Data.Aeson.Extra.Z
instance Data.Aeson.Types.Class.FromJSON Data.Aeson.Extra.Z
