Web.ArchLinux.API

Arch Linux official repositories APIs and AUR APIs.

These two kinds of APIs are distinguished by APIClient. Functions over them return APIClient parametrize by corresponding APIType.

Overall, there are five APIs available, refer to https://wiki.archlinux.org/index.php/Official_repositories_web_interface and https://wiki.archlinux.org/index.php/Aurweb_RPC_interface.

API Client

newtype APIClient (k :: APIType) a

A wrapper of ClientM, with BaseUrl reflected to type level phantom APIType.

Constructors

APIClient

Fields

• unWrapClientM :: ClientM a

Instances

MonadError ClientError (APIClient k)

Defined in Web.ArchLinux.API

Methods

throwError :: ClientError -> APIClient k a

catchError :: APIClient k a -> (ClientError -> APIClient k a) -> APIClient k a

MonadReader ClientEnv (APIClient k)

Defined in Web.ArchLinux.API

Methods

ask :: APIClient k ClientEnv

local :: (ClientEnv -> ClientEnv) -> APIClient k a -> APIClient k a

reader :: (ClientEnv -> a) -> APIClient k a

MonadIO (APIClient k)

Defined in Web.ArchLinux.API

Methods

liftIO :: IO a -> APIClient k a

Applicative (APIClient k)

Defined in Web.ArchLinux.API

Methods

pure :: a -> APIClient k a

(<*>) :: APIClient k (a -> b) -> APIClient k a -> APIClient k b

liftA2 :: (a -> b -> c) -> APIClient k a -> APIClient k b -> APIClient k c

(*>) :: APIClient k a -> APIClient k b -> APIClient k b

(<*) :: APIClient k a -> APIClient k b -> APIClient k a

Functor (APIClient k)

Defined in Web.ArchLinux.API

Methods

fmap :: (a -> b) -> APIClient k a -> APIClient k b

(<$) :: a -> APIClient k b -> APIClient k a

Monad (APIClient k)

Defined in Web.ArchLinux.API

Methods

(>>=) :: APIClient k a -> (a -> APIClient k b) -> APIClient k b

(>>) :: APIClient k a -> APIClient k b -> APIClient k b

return :: a -> APIClient k a

MonadCatch (APIClient k)

Defined in Web.ArchLinux.API

Methods

catch :: (HasCallStack, Exception e) => APIClient k a -> (e -> APIClient k a) -> APIClient k a

MonadThrow (APIClient k)

Defined in Web.ArchLinux.API

Methods

throwM :: (HasCallStack, Exception e) => e -> APIClient k a

RunClient (APIClient k)

Defined in Web.ArchLinux.API

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> APIClient k Response

throwClientError :: ClientError -> APIClient k a

Generic (APIClient k a)

Defined in Web.ArchLinux.API

Associated Types

type Rep (APIClient k a) :: Type -> Type

Methods

from :: APIClient k a -> Rep (APIClient k a) x

to :: Rep (APIClient k a) x -> APIClient k a

type Rep (APIClient k a)

Defined in Web.ArchLinux.API

type Rep (APIClient k a) = Rep (ClientM a)

data APIType

Two types of APIs.

Constructors

ArchLinux

Aur

class HasBaseUrl (k :: APIType) where

Class to reify BaseUrl from APIType.

Methods

getBaseUrl :: BaseUrl

Instances

HasBaseUrl 'ArchLinux

Defined in Web.ArchLinux.API

Methods

getBaseUrl :: BaseUrl

HasBaseUrl 'Aur

Defined in Web.ArchLinux.API

Methods

getBaseUrl :: BaseUrl

runAPIClient :: forall s a. HasBaseUrl s => Manager -> APIClient s a -> IO (Either ClientError a)

Runs APIClient.

It calls getBaseUrl, then creates ClientEnv, finally calls runClientM.

runAPIClient' :: HasBaseUrl s => APIClient s a -> IO (Either ClientError a)

Like runAPIClient, but creates a Manager.

Arch Linux official

data SearchOptions

Options available in searching packages in Arch Linux official repositories.

See searchPackage.

Constructors

SearchOptions

Fields

• _nameOrDescription :: Maybe Text
• _exactName :: Maybe Text
• _targetDescription :: Maybe Text
• _targetRepositories :: [Repo]
• _targetArchitectures :: [Arch]
• _targetMaintianer :: Maybe Text
• _targetPackager :: Maybe Text
• _isFlagged :: Maybe Flagged

Instances

Generic SearchOptions

Defined in Web.ArchLinux.API

Associated Types

type Rep SearchOptions :: Type -> Type

Methods

from :: SearchOptions -> Rep SearchOptions x

to :: Rep SearchOptions x -> SearchOptions

Show SearchOptions

Defined in Web.ArchLinux.API

Methods

showsPrec :: Int -> SearchOptions -> ShowS

show :: SearchOptions -> String

showList :: [SearchOptions] -> ShowS

Eq SearchOptions

Defined in Web.ArchLinux.API

Methods

(==) :: SearchOptions -> SearchOptions -> Bool

(/=) :: SearchOptions -> SearchOptions -> Bool

Ord SearchOptions

Defined in Web.ArchLinux.API

Methods

compare :: SearchOptions -> SearchOptions -> Ordering

(<) :: SearchOptions -> SearchOptions -> Bool

(<=) :: SearchOptions -> SearchOptions -> Bool

(>) :: SearchOptions -> SearchOptions -> Bool

(>=) :: SearchOptions -> SearchOptions -> Bool

max :: SearchOptions -> SearchOptions -> SearchOptions

min :: SearchOptions -> SearchOptions -> SearchOptions

type Rep SearchOptions

Defined in Web.ArchLinux.API

type Rep SearchOptions = D1 ('MetaData "SearchOptions" "Web.ArchLinux.API" "arch-web-0.3.1-G4JUEPhM0pIA1DtG7KVkWx" 'False) (C1 ('MetaCons "SearchOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_nameOrDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_exactName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_targetDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_targetRepositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Repo]))) :*: ((S1 ('MetaSel ('Just "_targetArchitectures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Arch]) :*: S1 ('MetaSel ('Just "_targetMaintianer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "_targetPackager") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "_isFlagged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Flagged))))))

emptySearchOptions :: SearchOptions

An empty options value for convenient.

For example,

let options =
      emptySearchOptions
        & nameOrDescription ?~ "kea"
        & targetRepositories .~ [Extra, ExtraTesting]
searchPackage options

searchs packages whose names or descriptions contain kea, from Extra or Extra-Testing.

getPackageDetails

Arguments

:: Repo

official repository

-> Arch

arch

-> Text

exact name

-> APIClient 'ArchLinux PackageInformation

Gets details of an exact package.

getPackageFiles

Arguments

:: Repo

official repository

-> Arch

arch

-> Text

exact name

-> APIClient 'ArchLinux PackageFiles

Gets files list of an exact package.

searchPackage :: SearchOptions -> APIClient 'ArchLinux (ArchLinuxResponse PackageInformation)

Searches packages.

See SearchOptions and emptySearchOptions.

AUR

data AurSearchType

Searches packages in AUR by what?

Constructors

ByName

ByNameOrDesc

ByMaintainer

ByDepends

ByMakedepends

ByOptdepends

ByCheckdepends

Instances

Enum AurSearchType

Defined in Web.ArchLinux.API

Methods

succ :: AurSearchType -> AurSearchType

pred :: AurSearchType -> AurSearchType

toEnum :: Int -> AurSearchType

fromEnum :: AurSearchType -> Int

enumFrom :: AurSearchType -> [AurSearchType]

enumFromThen :: AurSearchType -> AurSearchType -> [AurSearchType]

enumFromTo :: AurSearchType -> AurSearchType -> [AurSearchType]

enumFromThenTo :: AurSearchType -> AurSearchType -> AurSearchType -> [AurSearchType]

Generic AurSearchType

Defined in Web.ArchLinux.API

Associated Types

type Rep AurSearchType :: Type -> Type

Methods

from :: AurSearchType -> Rep AurSearchType x

to :: Rep AurSearchType x -> AurSearchType

Show AurSearchType

Defined in Web.ArchLinux.API

Methods

showsPrec :: Int -> AurSearchType -> ShowS

show :: AurSearchType -> String

showList :: [AurSearchType] -> ShowS

Eq AurSearchType

Defined in Web.ArchLinux.API

Methods

(==) :: AurSearchType -> AurSearchType -> Bool

(/=) :: AurSearchType -> AurSearchType -> Bool

Ord AurSearchType

Defined in Web.ArchLinux.API

Methods

compare :: AurSearchType -> AurSearchType -> Ordering

(<) :: AurSearchType -> AurSearchType -> Bool

(<=) :: AurSearchType -> AurSearchType -> Bool

(>) :: AurSearchType -> AurSearchType -> Bool

(>=) :: AurSearchType -> AurSearchType -> Bool

max :: AurSearchType -> AurSearchType -> AurSearchType

min :: AurSearchType -> AurSearchType -> AurSearchType

type Rep AurSearchType

Defined in Web.ArchLinux.API

type Rep AurSearchType = D1 ('MetaData "AurSearchType" "Web.ArchLinux.API" "arch-web-0.3.1-G4JUEPhM0pIA1DtG7KVkWx" 'False) ((C1 ('MetaCons "ByName" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ByNameOrDesc" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ByMaintainer" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ByDepends" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ByMakedepends" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ByOptdepends" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ByCheckdepends" 'PrefixI 'False) (U1 :: Type -> Type))))

searchAur

Arguments

:: AurSearchType

search type

-> Text

search argument

-> APIClient 'Aur (AurResponse [AurSearch])

Searches packages in AUR.

getAurInfo

Arguments

:: [Text]

exact names

-> APIClient 'Aur (AurResponse [AurInfo])

Gets details of a set of packages in AUR.