Safe Haskell	None
Language	Haskell2010

Polysemy.Http.Data.Request

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 :: LByteString
}
data Request = Request {
- _method :: Method
- _host :: Host
- _port :: Maybe Port
- _tls :: Tls
- _path :: Path
- _headers :: [(HeaderName, HeaderValue)]
- _query :: [(QueryKey, Maybe QueryValue)]
- _body :: Body
}
class HasRequest c where
- request :: Lens' c Request
- body :: Lens' c Body
- headers :: Lens' c [(HeaderName, HeaderValue)]
- host :: Lens' c Host
- method :: Lens' c Method
- path :: Lens' c Path
- port :: Lens' c (Maybe Port)
- query :: Lens' c [(QueryKey, Maybe QueryValue)]
- tls :: Lens' c Tls

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

Eq Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Show Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
IsString Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> Method #

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

Eq Host Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
Show Host Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #
IsString Host Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> Host #

newtype Port Source #

Request port.

Constructors

Port
Fields unPort :: Int

Instances

Instances details

Eq Port Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Port -> Port -> Bool # (/=) :: Port -> Port -> Bool #
Show Port Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Port -> ShowS # show :: Port -> String # showList :: [Port] -> ShowS #

newtype Tls Source #

A flag that indicates whether a request should use TLS.

Constructors

Tls
Fields unTls :: Bool

Instances

Instances details

Eq Tls Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Tls -> Tls -> Bool # (/=) :: Tls -> Tls -> Bool #
Show Tls Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Tls -> ShowS # show :: Tls -> String # showList :: [Tls] -> ShowS #

newtype Path Source #

Rrequest path.

Constructors

Path
Fields unPath :: Text

Instances

Instances details

Eq Path Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Show Path Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
IsString Path Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> Path #

newtype QueryKey Source #

The key of a query parameter.

Constructors

QueryKey
Fields unQueryKey :: Text

Instances

Instances details

Eq QueryKey Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: QueryKey -> QueryKey -> Bool # (/=) :: QueryKey -> QueryKey -> Bool #
Show QueryKey Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> QueryKey -> ShowS # show :: QueryKey -> String # showList :: [QueryKey] -> ShowS #
IsString QueryKey Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> QueryKey #

newtype QueryValue Source #

The value of a query parameter.

Constructors

QueryValue
Fields unQueryValue :: Text

Instances

Instances details

Eq QueryValue Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: QueryValue -> QueryValue -> Bool # (/=) :: QueryValue -> QueryValue -> Bool #
Show QueryValue Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> QueryValue -> ShowS # show :: QueryValue -> String # showList :: [QueryValue] -> ShowS #
IsString QueryValue Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> QueryValue #

newtype Body Source #

Request body, using LByteString because it is what encode produces.

Constructors

Body
Fields unBody :: LByteString

Instances

Instances details

Eq Body Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Body -> Body -> Bool # (/=) :: Body -> Body -> Bool #
Show Body Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Body -> ShowS # show :: Body -> String # showList :: [Body] -> ShowS #
IsString Body Source #
Instance details Defined in Polysemy.Http.Data.Request Methods fromString :: String -> Body #

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)] _query :: [(QueryKey, Maybe QueryValue)] _body :: Body

Instances

Instances details

Eq Request Source #
Instance details Defined in Polysemy.Http.Data.Request Methods (==) :: Request -> Request -> Bool # (/=) :: Request -> Request -> Bool #
Show Request Source #
Instance details Defined in Polysemy.Http.Data.Request Methods showsPrec :: Int -> Request -> ShowS # show :: Request -> String # showList :: [Request] -> ShowS #
HasRequest Request Source #
Instance details Defined in Polysemy.Http.Data.Request Methods request :: Lens' Request Request Source # body :: Lens' Request Body Source # headers :: Lens' Request [(HeaderName, HeaderValue)] Source # host :: Lens' Request Host Source # method :: Lens' Request Method Source # path :: Lens' Request Path Source # port :: Lens' Request (Maybe Port) Source # query :: Lens' Request [(QueryKey, Maybe QueryValue)] Source # tls :: Lens' Request Tls Source #