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


-- | Quick JSON extractions with Aeson
--   
--   DSL on top of Aeson. This library is <i>experimental</i>.
@package aeson-quick
@version 0.1.3

module Data.Aeson.Quick

-- | Extracts instances of <a>FromJSON</a> from a <a>Value</a>
--   
--   This is a wrapper around <a>extract</a> which does the actual work.
--   
--   Examples assume <a>FromJSON</a> Foo and <a>FromJSON</a> Bar.
--   
--   Extract key from object:
--   
--   <pre>
--   &gt;&gt;&gt; value .? "{key}" :: Maybe Foo
--   </pre>
--   
--   Extract list of objects:
--   
--   <pre>
--   &gt;&gt;&gt; value .? "[{key}]" :: Maybe [Foo]
--   </pre>
--   
--   Extract with optional key:
--   
--   <pre>
--   &gt;&gt;&gt; value .? "{key,opt?}" :: Maybe (Foo, Maybe Bar)
--   </pre>
(.?) :: FromJSON a => Value -> Structure -> Maybe a

-- | Unsafe version of <a>.?</a>. Returns <a>error</a> on failure.
(.!) :: FromJSON a => Value -> Structure -> a

-- | The <a>Parser</a> that executes a <a>Structure</a> against a
--   <a>Value</a> to return an instance of <a>FromJSON</a>.
extract :: FromJSON a => Structure -> Value -> Parser a

-- | Turns data into JSON objects.
--   
--   This is a wrapper around <a>build</a> which does the actual work.
--   
--   Build a simple Value:
--   
--   <pre>
--   &gt;&gt;&gt; encode $ "{a}" .% True
--   {\"a\": True}
--   </pre>
--   
--   Build a complex Value:
--   
--   <pre>
--   &gt;&gt;&gt; encode $ "[{a}]" '.%' [True, False]
--   "[{\"a\":true},{\"a\":false}]"
--   </pre>
(.%) :: ToJSON a => Structure -> a -> Value

-- | Executes a <a>Structure</a> against provided data to update a
--   <a>Value</a>.
--   
--   Note: <i>Still has undefined behaviours</i>, not at all stable.
build :: ToJSON a => Structure -> Value -> a -> Value
data Structure
Obj :: [(Text, Bool, Structure)] -> Structure
Arr :: Structure -> Structure
Val :: Structure

-- | Parse a structure, can fail
parseStructure :: Text -> Either String Structure
instance GHC.Generics.Generic Data.Aeson.Quick.Structure
instance GHC.Classes.Ord Data.Aeson.Quick.Structure
instance GHC.Classes.Eq Data.Aeson.Quick.Structure
instance Control.DeepSeq.NFData Data.Aeson.Quick.Structure
instance Data.String.IsString Data.Aeson.Quick.Structure
instance GHC.Show.Show Data.Aeson.Quick.Structure