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


-- | ArchLinux AUR json v5 API
--   
--   Implements ArchLinux AUR json v5 API defined at:
--   
--   <a>https://wiki.archlinux.org/index.php/AurJson</a>
@package aur-api
@version 0.1.2.1


-- | Primitive types used for AUR RPC (json) API.
module Distribution.ArchLinux.AUR.Types
data SearchBy
ByName :: SearchBy
ByNameDesc :: SearchBy
ByMaintainer :: SearchBy
data ReplyType
ReplySearch :: ReplyType
ReplyMultiInfo :: ReplyType
ReplyError :: ReplyType
data AURQuery
QSearch :: SearchBy -> String -> AURQuery
QInfo :: [String] -> AURQuery
data AURReply f a
AURReply :: Int -> ReplyType -> Int -> f a -> Maybe String -> AURReply f a
[retVersion] :: AURReply f a -> Int
[retType] :: AURReply f a -> ReplyType
[retResultCount] :: AURReply f a -> Int
[retResults] :: AURReply f a -> f a
[retError] :: AURReply f a -> Maybe String
data AURInfo
AURInfo :: Int -> Text -> Int -> Text -> Text -> Maybe Text -> Maybe Text -> Int -> Double -> Maybe Int -> Maybe Text -> Int -> Int -> Maybe Text -> [Text] -> [Text] -> [Text] -> [Text] -> [Text] -> [Text] -> AURInfo
[packageID] :: AURInfo -> Int
[packageName] :: AURInfo -> Text
[packagePackageBaseID] :: AURInfo -> Int
[packagePackageBase] :: AURInfo -> Text
[packageVersion] :: AURInfo -> Text
[packageDescription] :: AURInfo -> Maybe Text
[packageURL] :: AURInfo -> Maybe Text
[packageNumVotes] :: AURInfo -> Int
[packagePopularity] :: AURInfo -> Double
[packageOutOfDate] :: AURInfo -> Maybe Int
[packageMaintainer] :: AURInfo -> Maybe Text
[packageFirstSubmitted] :: AURInfo -> Int
[packageLastModified] :: AURInfo -> Int
[packageURLPath] :: AURInfo -> Maybe Text
[packageDepends] :: AURInfo -> [Text]
[packageMakeDepends] :: AURInfo -> [Text]
[packageOptDepends] :: AURInfo -> [Text]
[packageConflicts] :: AURInfo -> [Text]
[packageLicense] :: AURInfo -> [Text]
[packageKeywords] :: AURInfo -> [Text]
getAURInfo :: (Functor f, Applicative f, Foldable f, Traversable f) => AURReply f a -> Either String (f a)
instance GHC.Show.Show Distribution.ArchLinux.AUR.Types.AURInfo
instance GHC.Base.Functor f => GHC.Base.Functor (Distribution.ArchLinux.AUR.Types.AURReply f)
instance GHC.Show.Show (f a) => GHC.Show.Show (Distribution.ArchLinux.AUR.Types.AURReply f a)
instance GHC.Show.Show Distribution.ArchLinux.AUR.Types.SearchBy
instance GHC.Show.Show Distribution.ArchLinux.AUR.Types.ReplyType
instance (GHC.Base.Functor f, GHC.Base.Applicative f, Data.Foldable.Foldable f, Data.Traversable.Traversable f, Data.Aeson.Types.Class.FromJSON a, Data.Aeson.Types.Class.FromJSON (f a)) => Data.Aeson.Types.Class.FromJSON (Distribution.ArchLinux.AUR.Types.AURReply f a)
instance Data.Aeson.Types.Class.FromJSON Distribution.ArchLinux.AUR.Types.AURInfo


-- | AUR json API implementation (v5)
--   
--   AUR json API spec can be found at
--   <a>https://wiki.archlinux.org/index.php/AurJson</a>
module Distribution.ArchLinux.AUR.RPC

-- | Query info of given list of packages, match exact names possible
--   return types are <i>multiinfo</i> and <i>error</i>. <i>error</i> type
--   is captured by ExceptT (Left). However, query may return empty list
--   which isn't considered as an error.
info :: (MonadIO m) => [String] -> ExceptT String m [AURInfo]

-- | searchBy field <a>SearchBy</a> given string on AUR server possible
--   return types are <i>search</i> and <i>error</i>. Like <a>info</a>,
--   <i>error</i> is captured by a Left.
searchBy :: (MonadIO m) => SearchBy -> String -> ExceptT String m [AURInfo]

-- | synonym of <a>searchBy</a> <i>ByNameDesc</i>
search :: (MonadIO m) => String -> ExceptT String m [AURInfo]


-- | Implements AUR json API (v5)
--   
--   AUR json API spec can be found at
--   <a>https://wiki.archlinux.org/index.php/AurJson</a>
--   
--   <ul>
--   <li><a>info</a>: Query metadata for list of packages (match exact
--   names)</li>
--   <li><a>searchBy</a>: Search a given pattern by either <i>name</i>,
--   <i>desc</i>, or <i>name-desc</i></li>
--   <li><a>search</a>: Synonym of <i>searchBy ByNameDesc</i>.</li>
--   </ul>
module Distribution.ArchLinux.AUR
data SearchBy
ByName :: SearchBy
ByNameDesc :: SearchBy
ByMaintainer :: SearchBy
data AURInfo
AURInfo :: Int -> Text -> Int -> Text -> Text -> Maybe Text -> Maybe Text -> Int -> Double -> Maybe Int -> Maybe Text -> Int -> Int -> Maybe Text -> [Text] -> [Text] -> [Text] -> [Text] -> [Text] -> [Text] -> AURInfo
[packageID] :: AURInfo -> Int
[packageName] :: AURInfo -> Text
[packagePackageBaseID] :: AURInfo -> Int
[packagePackageBase] :: AURInfo -> Text
[packageVersion] :: AURInfo -> Text
[packageDescription] :: AURInfo -> Maybe Text
[packageURL] :: AURInfo -> Maybe Text
[packageNumVotes] :: AURInfo -> Int
[packagePopularity] :: AURInfo -> Double
[packageOutOfDate] :: AURInfo -> Maybe Int
[packageMaintainer] :: AURInfo -> Maybe Text
[packageFirstSubmitted] :: AURInfo -> Int
[packageLastModified] :: AURInfo -> Int
[packageURLPath] :: AURInfo -> Maybe Text
[packageDepends] :: AURInfo -> [Text]
[packageMakeDepends] :: AURInfo -> [Text]
[packageOptDepends] :: AURInfo -> [Text]
[packageConflicts] :: AURInfo -> [Text]
[packageLicense] :: AURInfo -> [Text]
[packageKeywords] :: AURInfo -> [Text]

-- | Query info of given list of packages, match exact names possible
--   return types are <i>multiinfo</i> and <i>error</i>. <i>error</i> type
--   is captured by ExceptT (Left). However, query may return empty list
--   which isn't considered as an error.
info :: (MonadIO m) => [String] -> ExceptT String m [AURInfo]

-- | searchBy field <a>SearchBy</a> given string on AUR server possible
--   return types are <i>search</i> and <i>error</i>. Like <a>info</a>,
--   <i>error</i> is captured by a Left.
searchBy :: (MonadIO m) => SearchBy -> String -> ExceptT String m [AURInfo]

-- | synonym of <a>searchBy</a> <i>ByNameDesc</i>
search :: (MonadIO m) => String -> ExceptT String m [AURInfo]