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


-- | A tiny JSON library with light dependency footprint
--   
--   <tt>microaeson</tt> aims to provide a <a>RFC 8259</a> compliant
--   JavaScript Object Notation (JSON) implementation. The
--   <a>microaeson</a> package provides a smaller subset of the
--   <a>aeson</a> API with less dependencies and a simpler implementation.
--   
--   The API is designed in such a way to allow to easily convert client
--   code written against <tt>microaeson</tt>'s API to use the full
--   <a>aeson</a> API.
@package microaeson
@version 0.1.0.2


-- | Minimal JavaScript Object Notation (JSON) support as per <a>RFC
--   8259</a>.
--   
--   This API provides a subset (with a couple of divergences; see below)
--   of <a>aeson API</a> but puts the emphasis on simplicity rather than
--   performance and features.
--   
--   The <a>ToJSON</a> and <a>FromJSON</a> instances are intended to have
--   an encoding compatible with <tt>aeson</tt>'s encoding.
--   
--   <h2>Limitations and divergences from <tt>aeson</tt>'s API</h2>
--   
--   In order to reduce the dependency footprint and keep the code simpler,
--   the following divergences from the <tt>aeson</tt> API have to be made:
--   
--   <ul>
--   <li>There are no <a>FromJSON</a>/<a>ToJSON</a> instances for
--   <a>Char</a> &amp; <a>Value</a>.</li>
--   <li>The type synonym (&amp; the constructor of the same name)
--   <a>Value</a> uses <tt>containers</tt>'s <a>Map</a> rather than a
--   <tt>HashMap</tt> <tt>unordered-containers</tt>.</li>
--   <li><a>Array</a> is represented by an ordinary list rather than a
--   <tt>Vector</tt> from the <tt>vector</tt> package.</li>
--   <li><a>Number</a> uses <a>Double</a> instead of
--   <tt>Scientific</tt></li>
--   </ul>
module Data.Aeson.Micro

-- | A JSON value represented as a Haskell value.
data Value
Object :: !Object -> Value
Array :: [Value] -> Value
String :: !Text -> Value
Number :: !Double -> Value
Bool :: !Bool -> Value
Null :: Value

-- | A JSON "object" (key/value map).
type Object = Map Text Value

-- | A key/value pair for an <a>Value</a>
type Pair = (Text, Value)

-- | A key-value pair for encoding a JSON object.
(.=) :: ToJSON v => Text -> v -> Pair
infixr 8 .=

-- | Create a <a>Value</a> from a list of name/value <a>Pair</a>s.
object :: [Pair] -> Value

-- | The empty JSON <a>Array</a> (i.e. <tt>[]</tt>).
emptyArray :: Value

-- | The empty JSON <a>Value</a> (i.e. <tt>{}</tt>).
emptyObject :: Value
(.:) :: FromJSON a => Object -> Text -> Parser a
(.:?) :: FromJSON a => Object -> Text -> Parser (Maybe a)
(.:!) :: FromJSON a => Object -> Text -> Parser (Maybe a)
(.!=) :: Parser (Maybe a) -> a -> Parser a

-- | Serialise value as JSON/UTF-8-encoded lazy <a>ByteString</a>
encode :: ToJSON a => a -> ByteString

-- | Serialise value as JSON/UTF-8-encoded strict <a>ByteString</a>
encodeStrict :: ToJSON a => a -> ByteString

-- | Serialise value as JSON/UTF8-encoded <a>Builder</a>
encodeToBuilder :: ToJSON a => a -> Builder

-- | Decode a single JSON document
decodeStrict :: FromJSON a => ByteString -> Maybe a

-- | Decode a single JSON document
decode :: FromJSON a => ByteString -> Maybe a

-- | Decode multiple concatenated JSON documents
decodeStrictN :: FromJSON a => ByteString -> Maybe [a]
withObject :: String -> (Object -> Parser a) -> Value -> Parser a
withText :: String -> (Text -> Parser a) -> Value -> Parser a
withArray :: String -> ([Value] -> Parser a) -> Value -> Parser a
withNumber :: String -> (Double -> Parser a) -> Value -> Parser a
withBool :: String -> (Bool -> Parser a) -> Value -> Parser a

-- | A type that JSON can be deserialised into
class FromJSON a

-- | Decode a JSON value into a native Haskell type
parseJSON :: FromJSON a => Value -> Parser a

-- | JSON Parser <a>Monad</a> used by <a>FromJSON</a>
data Parser a

-- | Run <a>Parser</a>.
--   
--   A common use-case is <tt><a>parseMaybe</a> <a>parseJSON</a></tt>.
parseMaybe :: (a -> Parser b) -> a -> Maybe b

-- | A type that can be converted to JSON.
class ToJSON a

-- | Convert a Haskell value to a JSON-friendly intermediate type.
toJSON :: ToJSON a => a -> Value
instance Data.Data.Data Data.Aeson.Micro.Value
instance GHC.Generics.Generic Data.Aeson.Micro.Value
instance GHC.Show.Show Data.Aeson.Micro.Value
instance GHC.Read.Read Data.Aeson.Micro.Value
instance GHC.Classes.Eq Data.Aeson.Micro.Value
instance Control.Monad.Fail.MonadFail Data.Aeson.Micro.Parser
instance GHC.Base.Monad Data.Aeson.Micro.Parser
instance GHC.Base.Applicative Data.Aeson.Micro.Parser
instance GHC.Base.Functor Data.Aeson.Micro.Parser
instance Data.Aeson.Micro.FromJSON Data.Aeson.Micro.Value
instance Data.Aeson.Micro.FromJSON GHC.Types.Bool
instance Data.Aeson.Micro.FromJSON Data.Text.Internal.Text
instance Data.Aeson.Micro.FromJSON Data.Text.Internal.Lazy.Text
instance Data.Aeson.Micro.FromJSON a => Data.Aeson.Micro.FromJSON [a]
instance Data.Aeson.Micro.FromJSON GHC.Types.Double
instance Data.Aeson.Micro.FromJSON GHC.Types.Float
instance Data.Aeson.Micro.FromJSON GHC.Num.Integer.Integer
instance Data.Aeson.Micro.FromJSON GHC.Types.Int
instance Data.Aeson.Micro.FromJSON GHC.Int.Int8
instance Data.Aeson.Micro.FromJSON GHC.Int.Int16
instance Data.Aeson.Micro.FromJSON GHC.Int.Int32
instance Data.Aeson.Micro.FromJSON GHC.Int.Int64
instance Data.Aeson.Micro.FromJSON GHC.Types.Word
instance Data.Aeson.Micro.FromJSON GHC.Word.Word8
instance Data.Aeson.Micro.FromJSON GHC.Word.Word16
instance Data.Aeson.Micro.FromJSON GHC.Word.Word32
instance Data.Aeson.Micro.FromJSON GHC.Word.Word64
instance Data.Aeson.Micro.FromJSON ()
instance (Data.Aeson.Micro.FromJSON a, Data.Aeson.Micro.FromJSON b) => Data.Aeson.Micro.FromJSON (a, b)
instance (Data.Aeson.Micro.FromJSON a, Data.Aeson.Micro.FromJSON b, Data.Aeson.Micro.FromJSON c) => Data.Aeson.Micro.FromJSON (a, b, c)
instance (Data.Aeson.Micro.FromJSON a, Data.Aeson.Micro.FromJSON b, Data.Aeson.Micro.FromJSON c, Data.Aeson.Micro.FromJSON d) => Data.Aeson.Micro.FromJSON (a, b, c, d)
instance Data.Aeson.Micro.FromJSON a => Data.Aeson.Micro.FromJSON (GHC.Maybe.Maybe a)
instance Data.Aeson.Micro.FromJSON GHC.Types.Ordering
instance Data.Aeson.Micro.FromJSON v => Data.Aeson.Micro.FromJSON (Data.Map.Internal.Map Data.Text.Internal.Text v)
instance Data.Aeson.Micro.ToJSON ()
instance Data.Aeson.Micro.ToJSON Data.Aeson.Micro.Value
instance Data.Aeson.Micro.ToJSON GHC.Types.Bool
instance Data.Aeson.Micro.ToJSON a => Data.Aeson.Micro.ToJSON [a]
instance Data.Aeson.Micro.ToJSON v => Data.Aeson.Micro.ToJSON (Data.Map.Internal.Map Data.Text.Internal.Text v)
instance Data.Aeson.Micro.ToJSON a => Data.Aeson.Micro.ToJSON (GHC.Maybe.Maybe a)
instance (Data.Aeson.Micro.ToJSON a, Data.Aeson.Micro.ToJSON b) => Data.Aeson.Micro.ToJSON (a, b)
instance (Data.Aeson.Micro.ToJSON a, Data.Aeson.Micro.ToJSON b, Data.Aeson.Micro.ToJSON c) => Data.Aeson.Micro.ToJSON (a, b, c)
instance (Data.Aeson.Micro.ToJSON a, Data.Aeson.Micro.ToJSON b, Data.Aeson.Micro.ToJSON c, Data.Aeson.Micro.ToJSON d) => Data.Aeson.Micro.ToJSON (a, b, c, d)
instance Data.Aeson.Micro.ToJSON Data.Text.Internal.Text
instance Data.Aeson.Micro.ToJSON Data.Text.Internal.Lazy.Text
instance Data.Aeson.Micro.ToJSON GHC.Types.Float
instance Data.Aeson.Micro.ToJSON GHC.Types.Double
instance Data.Aeson.Micro.ToJSON GHC.Types.Int
instance Data.Aeson.Micro.ToJSON GHC.Int.Int8
instance Data.Aeson.Micro.ToJSON GHC.Int.Int16
instance Data.Aeson.Micro.ToJSON GHC.Int.Int32
instance Data.Aeson.Micro.ToJSON GHC.Types.Word
instance Data.Aeson.Micro.ToJSON GHC.Word.Word8
instance Data.Aeson.Micro.ToJSON GHC.Word.Word16
instance Data.Aeson.Micro.ToJSON GHC.Word.Word32
instance Data.Aeson.Micro.ToJSON GHC.Int.Int64
instance Data.Aeson.Micro.ToJSON GHC.Word.Word64
instance Data.Aeson.Micro.ToJSON GHC.Num.Integer.Integer
instance Control.DeepSeq.NFData Data.Aeson.Micro.Value
instance Data.String.IsString Data.Aeson.Micro.Value