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


-- | Quick JSON extractions with Aeson
--   
--   Small DSL on top of Aeson for casual and concise JSON construction and
--   deconstruction.
@package aeson-quick
@version 0.2.0

module Data.Aeson.Quick.Internal
data Bounds
All :: Bounds
Single :: Int -> Bounds
Range :: Int -> Maybe Int -> Bounds
instance GHC.Show.Show Data.Aeson.Quick.Internal.Bounds
instance GHC.Generics.Generic Data.Aeson.Quick.Internal.Bounds
instance GHC.Classes.Ord Data.Aeson.Quick.Internal.Bounds
instance GHC.Classes.Eq Data.Aeson.Quick.Internal.Bounds
instance Control.DeepSeq.NFData Data.Aeson.Quick.Internal.Bounds

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 -> Quick -> Maybe a

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

-- | The <a>Parser</a> that executes a <a>Quick</a> against a <a>Value</a>
--   to return an instance of <a>FromJSON</a>.
extract :: FromJSON a => Quick -> 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 => Quick -> a -> Value

-- | Executes a <a>Quick</a> against provided data to update a
--   <a>Value</a>.
build :: ToJSON a => Quick -> a -> Either String Value
data Quick
Obj :: [(KeyType, Bool, Quick)] -> Quick
Arr :: Quick -> Bounds -> Quick
Val :: Quick

-- | Parse a structure, can fail
parseQuick :: Text -> Either String Quick

-- | QuasiQuoter for a structure, provides compile time checking ie:
--   
--   <pre>
--   &gt;&gt;&gt; val .! [quick|{foo,bar}|]
--   </pre>
quick :: QuasiQuoter
jsonlit :: QuasiQuoter
instance GHC.Generics.Generic Data.Aeson.Quick.Quick
instance GHC.Classes.Ord Data.Aeson.Quick.Quick
instance GHC.Classes.Eq Data.Aeson.Quick.Quick
instance Control.DeepSeq.NFData Data.Aeson.Quick.Quick
instance Data.String.IsString Data.Aeson.Quick.Quick
instance GHC.Show.Show Data.Aeson.Quick.Quick