github-0.20: Access to the GitHub API, v3.

LicenseBSD-3-Clause
MaintainerOleg Grenrus <oleg.grenrus@iki.fi>
Safe HaskellNone
LanguageHaskell2010

GitHub.Data.Request

Contents

Description

 
Synopsis

Request

data Request (k :: RW) a where Source #

Github request data type.

  • k describes whether authentication is required. It's required for non-GET requests.
  • a is the result type

Note: Request is not Functor on purpose.

Instances
Eq a => Eq (Request k a) Source # 
Instance details

Defined in GitHub.Data.Request

Methods

(==) :: Request k a -> Request k a -> Bool Source #

(/=) :: Request k a -> Request k a -> Bool Source #

Ord a => Ord (Request k a) Source # 
Instance details

Defined in GitHub.Data.Request

Methods

compare :: Request k a -> Request k a -> Ordering Source #

(<) :: Request k a -> Request k a -> Bool Source #

(<=) :: Request k a -> Request k a -> Bool Source #

(>) :: Request k a -> Request k a -> Bool Source #

(>=) :: Request k a -> Request k a -> Bool Source #

max :: Request k a -> Request k a -> Request k a Source #

min :: Request k a -> Request k a -> Request k a Source #

Show (Request k a) Source # 
Instance details

Defined in GitHub.Data.Request

Methods

showsPrec :: Int -> Request k a -> ShowS Source #

show :: Request k a -> String Source #

showList :: [Request k a] -> ShowS Source #

Hashable (Request k a) Source # 
Instance details

Defined in GitHub.Data.Request

Methods

hashWithSalt :: Int -> Request k a -> Int Source #

hash :: Request k a -> Int Source #

data SimpleRequest (k :: RW) a where Source #

Instances
Eq a => Eq (SimpleRequest k a) Source # 
Instance details

Defined in GitHub.Data.Request

Ord a => Ord (SimpleRequest k a) Source # 
Instance details

Defined in GitHub.Data.Request

Show (SimpleRequest k a) Source # 
Instance details

Defined in GitHub.Data.Request

Hashable (SimpleRequest k a) Source # 
Instance details

Defined in GitHub.Data.Request

Smart constructors

Auxiliary types

data RW Source #

Type used as with DataKinds to tag whether requests need authentication or aren't read-only.

Constructors

RO

Read-only, doesn't necessarily requires authentication

RA

Read autenticated

RW

Read-write, requires authentication

Instances
Bounded RW Source # 
Instance details

Defined in GitHub.Data.Request

Enum RW Source # 
Instance details

Defined in GitHub.Data.Request

Methods

succ :: RW -> RW Source #

pred :: RW -> RW Source #

toEnum :: Int -> RW Source #

fromEnum :: RW -> Int Source #

enumFrom :: RW -> [RW] Source #

enumFromThen :: RW -> RW -> [RW] Source #

enumFromTo :: RW -> RW -> [RW] Source #

enumFromThenTo :: RW -> RW -> RW -> [RW] Source #

Eq RW Source # 
Instance details

Defined in GitHub.Data.Request

Methods

(==) :: RW -> RW -> Bool Source #

(/=) :: RW -> RW -> Bool Source #

Data RW Source # 
Instance details

Defined in GitHub.Data.Request

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RW -> c RW Source #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RW Source #

toConstr :: RW -> Constr Source #

dataTypeOf :: RW -> DataType Source #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RW) Source #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RW) Source #

gmapT :: (forall b. Data b => b -> b) -> RW -> RW Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RW -> r Source #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RW -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> RW -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RW -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RW -> m RW Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RW -> m RW Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RW -> m RW Source #

Ord RW Source # 
Instance details

Defined in GitHub.Data.Request

Methods

compare :: RW -> RW -> Ordering Source #

(<) :: RW -> RW -> Bool Source #

(<=) :: RW -> RW -> Bool Source #

(>) :: RW -> RW -> Bool Source #

(>=) :: RW -> RW -> Bool Source #

max :: RW -> RW -> RW Source #

min :: RW -> RW -> RW Source #

Read RW Source # 
Instance details

Defined in GitHub.Data.Request

Show RW Source # 
Instance details

Defined in GitHub.Data.Request

Generic RW Source # 
Instance details

Defined in GitHub.Data.Request

Associated Types

type Rep RW :: Type -> Type Source #

Methods

from :: RW -> Rep RW x Source #

to :: Rep RW x -> RW Source #

type Rep RW Source # 
Instance details

Defined in GitHub.Data.Request

type Rep RW = D1 (MetaData "RW" "GitHub.Data.Request" "github-0.20-EqsirKiH6Hk89stA2S25YD" False) (C1 (MetaCons "RO" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "RA" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "RW" PrefixI False) (U1 :: Type -> Type)))

type StatusMap a = [(Int, a)] Source #

data FetchCount Source #

PagedQuery returns just some results, using this data we can specify how many pages we want to fetch.

Constructors

FetchAtLeast !Word 
FetchAll 
Instances
Eq FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Num FetchCount Source #

This instance is there mostly for fromInteger.

Instance details

Defined in GitHub.Data.Request

Ord FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Read FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Show FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Generic FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Associated Types

type Rep FetchCount :: Type -> Type Source #

Hashable FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Binary FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

NFData FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

Methods

rnf :: FetchCount -> () Source #

type Rep FetchCount Source # 
Instance details

Defined in GitHub.Data.Request

type Rep FetchCount = D1 (MetaData "FetchCount" "GitHub.Data.Request" "github-0.20-EqsirKiH6Hk89stA2S25YD" False) (C1 (MetaCons "FetchAtLeast" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Word)) :+: C1 (MetaCons "FetchAll" PrefixI False) (U1 :: Type -> Type))

type Paths = [Text] Source #

class IsPathPart a where Source #

Methods

toPathPart :: a -> Text Source #

Instances
IsPathPart ArchiveFormat Source # 
Instance details

Defined in GitHub.Data.Repos

IsPathPart (Name a) Source # 
Instance details

Defined in GitHub.Data.Request

Methods

toPathPart :: Name a -> Text Source #

IsPathPart (Id a) Source # 
Instance details

Defined in GitHub.Data.Request

Methods

toPathPart :: Id a -> Text Source #

type QueryString = [(ByteString, Maybe ByteString)] Source #

Request query string

type Count = Int Source #

Count of elements