Safe Haskell	None
Language	GHC2021

Polysemy.Http.Data.Request

Description

Synopsis

data Method
- = Get
- | Post
- | Put
- | Delete
- | Head
- | Trace
- | Connect
- | Options
- | Patch
- | Custom Text
methodUpper :: Method -> Text
newtype Host = Host {
- unHost :: Text
}
newtype Port = Port {
- unPort :: Int
}
newtype Tls = Tls {
- unTls :: Bool
}
newtype Path = Path {
- unPath :: Text
}
newtype QueryKey = QueryKey {
- unQueryKey :: Text
}
newtype QueryValue = QueryValue {
- unQueryValue :: Text
}
newtype Body = Body {
- unBody :: ByteString
}
data Request = Request {
- method :: Method
- host :: Host
- port :: Maybe Port
- tls :: Tls
- path :: Path
- headers :: [(HeaderName, HeaderValue)]
- cookies :: CookieJar
- query :: [(QueryKey, Maybe QueryValue)]
- body :: Body
}

Documentation

data Method Source #

All standard HTTP methods, mirroring those from Types, plus a constructor for arbitrary strings.

Constructors

Get
Post
Put
Delete
Head
Trace
Connect
Options
Patch
Custom Text

Instances

Instances details

FromJSON Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] # omittedField :: Maybe Method #
ToJSON Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods toJSON :: Method -> Value # toEncoding :: Method -> Encoding # toJSONList :: [Method] -> Value # toEncodingList :: [Method] -> Encoding # omitField :: Method -> Bool #
IsString Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> Method #
Show Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
Eq Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #

methodUpper :: Method -> Text Source #

Produce the usual uppercase representation of a method.

newtype Host Source #

Request host name.

Constructors

Host
Fields unHost :: Text

Instances

Instances details

FromJSON Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Host #

parseJSONList :: Value -> Parser [Host] #

omittedField :: Maybe Host #

ToJSON Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Host -> Value #

toEncoding :: Host -> Encoding #

toJSONList :: [Host] -> Value #

toEncodingList :: [Host] -> Encoding #

omitField :: Host -> Bool #

IsString Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Host #

Generic Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Host
Instance details Defined in Polysemy.Http.Data.Request type Rep Host = D1 ('MetaData "Host" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Host" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Host -> Rep Host x #

to :: Rep Host x -> Host #

Show Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Host -> ShowS #

show :: Host -> String #

showList :: [Host] -> ShowS #

Eq Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Host -> Host -> Bool #

(/=) :: Host -> Host -> Bool #

type Rep Host Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep Host = D1 ('MetaData "Host" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Host" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype Port Source #

Request port.

Constructors

Port
Fields unPort :: Int

Instances

Instances details

FromJSON Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Port #

parseJSONList :: Value -> Parser [Port] #

omittedField :: Maybe Port #

ToJSON Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Port -> Value #

toEncoding :: Port -> Encoding #

toJSONList :: [Port] -> Value #

toEncodingList :: [Port] -> Encoding #

omitField :: Port -> Bool #

Enum Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

succ :: Port -> Port #

pred :: Port -> Port #

toEnum :: Int -> Port #

fromEnum :: Port -> Int #

enumFrom :: Port -> [Port] #

enumFromThen :: Port -> Port -> [Port] #

enumFromTo :: Port -> Port -> [Port] #

enumFromThenTo :: Port -> Port -> Port -> [Port] #

Generic Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Port
Instance details Defined in Polysemy.Http.Data.Request type Rep Port = D1 ('MetaData "Port" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Port" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: Port -> Rep Port x #

to :: Rep Port x -> Port #

Num Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(+) :: Port -> Port -> Port #

(-) :: Port -> Port -> Port #

(*) :: Port -> Port -> Port #

negate :: Port -> Port #

abs :: Port -> Port #

signum :: Port -> Port #

fromInteger :: Integer -> Port #

Read Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

readsPrec :: Int -> ReadS Port #

readList :: ReadS [Port] #

readPrec :: ReadPrec Port #

readListPrec :: ReadPrec [Port] #

Integral Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

quot :: Port -> Port -> Port #

rem :: Port -> Port -> Port #

div :: Port -> Port -> Port #

mod :: Port -> Port -> Port #

quotRem :: Port -> Port -> (Port, Port) #

divMod :: Port -> Port -> (Port, Port) #

toInteger :: Port -> Integer #

Real Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toRational :: Port -> Rational #

Show Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Port -> ShowS #

show :: Port -> String #

showList :: [Port] -> ShowS #

Eq Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Port -> Port -> Bool #

(/=) :: Port -> Port -> Bool #

Ord Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

compare :: Port -> Port -> Ordering #

(<) :: Port -> Port -> Bool #

(<=) :: Port -> Port -> Bool #

(>) :: Port -> Port -> Bool #

(>=) :: Port -> Port -> Bool #

max :: Port -> Port -> Port #

min :: Port -> Port -> Port #

type Rep Port Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep Port = D1 ('MetaData "Port" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Port" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

newtype Tls Source #

A flag that indicates whether a request should use TLS.

Constructors

Tls
Fields unTls :: Bool

Instances

Instances details

FromJSON Tls Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Tls #

parseJSONList :: Value -> Parser [Tls] #

omittedField :: Maybe Tls #

ToJSON Tls Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Tls -> Value #

toEncoding :: Tls -> Encoding #

toJSONList :: [Tls] -> Value #

toEncodingList :: [Tls] -> Encoding #

omitField :: Tls -> Bool #

Generic Tls Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Tls
Instance details Defined in Polysemy.Http.Data.Request type Rep Tls = D1 ('MetaData "Tls" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Tls" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

Methods

from :: Tls -> Rep Tls x #

to :: Rep Tls x -> Tls #

Show Tls Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Tls -> ShowS #

show :: Tls -> String #

showList :: [Tls] -> ShowS #

Eq Tls Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Tls -> Tls -> Bool #

(/=) :: Tls -> Tls -> Bool #

type Rep Tls Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep Tls = D1 ('MetaData "Tls" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Tls" 'PrefixI 'True) (S1 ('MetaSel ('Just "unTls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

newtype Path Source #

Rrequest path.

Constructors

Path
Fields unPath :: Text

Instances

Instances details

FromJSON Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Path #

parseJSONList :: Value -> Parser [Path] #

omittedField :: Maybe Path #

ToJSON Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Path -> Value #

toEncoding :: Path -> Encoding #

toJSONList :: [Path] -> Value #

toEncodingList :: [Path] -> Encoding #

omitField :: Path -> Bool #

IsString Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Path #

Monoid Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

mempty :: Path #

mappend :: Path -> Path -> Path #

mconcat :: [Path] -> Path #

Semigroup Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(<>) :: Path -> Path -> Path #

sconcat :: NonEmpty Path -> Path #

stimes :: Integral b => b -> Path -> Path #

Generic Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Path
Instance details Defined in Polysemy.Http.Data.Request type Rep Path = D1 ('MetaData "Path" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Path" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Path -> Rep Path x #

to :: Rep Path x -> Path #

Show Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Path -> ShowS #

show :: Path -> String #

showList :: [Path] -> ShowS #

Eq Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Path -> Path -> Bool #

(/=) :: Path -> Path -> Bool #

type Rep Path Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep Path = D1 ('MetaData "Path" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Path" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype QueryKey Source #

The key of a query parameter.

Constructors

QueryKey
Fields unQueryKey :: Text

Instances

Instances details

FromJSON QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser QueryKey #

parseJSONList :: Value -> Parser [QueryKey] #

omittedField :: Maybe QueryKey #

ToJSON QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: QueryKey -> Value #

toEncoding :: QueryKey -> Encoding #

toJSONList :: [QueryKey] -> Value #

toEncodingList :: [QueryKey] -> Encoding #

omitField :: QueryKey -> Bool #

IsString QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> QueryKey #

Generic QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep QueryKey
Instance details Defined in Polysemy.Http.Data.Request type Rep QueryKey = D1 ('MetaData "QueryKey" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "QueryKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unQueryKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: QueryKey -> Rep QueryKey x #

to :: Rep QueryKey x -> QueryKey #

Show QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> QueryKey -> ShowS #

show :: QueryKey -> String #

showList :: [QueryKey] -> ShowS #

Eq QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: QueryKey -> QueryKey -> Bool #

(/=) :: QueryKey -> QueryKey -> Bool #

type Rep QueryKey Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep QueryKey = D1 ('MetaData "QueryKey" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "QueryKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "unQueryKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype QueryValue Source #

The value of a query parameter.

Constructors

QueryValue
Fields unQueryValue :: Text

Instances

Instances details

FromJSON QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser QueryValue #

parseJSONList :: Value -> Parser [QueryValue] #

omittedField :: Maybe QueryValue #

ToJSON QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: QueryValue -> Value #

toEncoding :: QueryValue -> Encoding #

toJSONList :: [QueryValue] -> Value #

toEncodingList :: [QueryValue] -> Encoding #

omitField :: QueryValue -> Bool #

IsString QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> QueryValue #

Generic QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep QueryValue
Instance details Defined in Polysemy.Http.Data.Request type Rep QueryValue = D1 ('MetaData "QueryValue" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "QueryValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "unQueryValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: QueryValue -> Rep QueryValue x #

to :: Rep QueryValue x -> QueryValue #

Show QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> QueryValue -> ShowS #

show :: QueryValue -> String #

showList :: [QueryValue] -> ShowS #

Eq QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: QueryValue -> QueryValue -> Bool #

(/=) :: QueryValue -> QueryValue -> Bool #

type Rep QueryValue Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep QueryValue = D1 ('MetaData "QueryValue" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "QueryValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "unQueryValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype Body Source #

Request body.

Constructors

Body
Fields unBody :: ByteString

Instances

Instances details

IsString Body Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Body #

Generic Body Source #

Instance details

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Body
Instance details Defined in Polysemy.Http.Data.Request type Rep Body = D1 ('MetaData "Body" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Body" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: Body -> Rep Body x #

to :: Rep Body x -> Body #

Show Body Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Body -> ShowS #

show :: Body -> String #

showList :: [Body] -> ShowS #

Eq Body Source #

Instance details

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Body -> Body -> Bool #

(/=) :: Body -> Body -> Bool #

type Rep Body Source #

Instance details

Defined in Polysemy.Http.Data.Request

type Rep Body = D1 ('MetaData "Body" "Polysemy.Http.Data.Request" "polysemy-http-0.13.1.0-HslaAdsBwfBFVTgN9RdJNp" 'True) (C1 ('MetaCons "Body" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data Request Source #

HTTP request parameters, used by Http.

Constructors

Request
Fields method :: Method host :: Host port :: Maybe Port tls :: Tls path :: Path headers :: [(HeaderName, HeaderValue)] cookies :: CookieJar query :: [(QueryKey, Maybe QueryValue)] body :: Body