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)]
- _cookies :: CookieJar
- _query :: [(QueryKey, Maybe QueryValue)]
- _body :: Body
}
class HasRequest c where
- request :: Lens' c Request
- body :: Lens' c Body
- cookies :: Lens' c CookieJar
- 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 #
ToJSON Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods toJSON :: Method -> Value # toEncoding :: Method -> Encoding # toJSONList :: [Method] -> Value # toEncodingList :: [Method] -> Encoding #
FromJSON Method Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [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 #
Generic Host Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep Host :: Type -> Type # Methods from :: Host -> Rep Host x # to :: Rep Host x -> 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 #
FromJSON Host Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser Host # parseJSONList :: Value -> Parser [Host] #
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.4.0.5-inplace" '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

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 #
Generic Port Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep Port :: Type -> Type # Methods from :: Port -> Rep Port x # to :: Rep Port x -> 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 #
FromJSON Port Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser Port # parseJSONList :: Value -> Parser [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.4.0.5-inplace" '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

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 #
Generic Tls Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep Tls :: Type -> Type # Methods from :: Tls -> Rep Tls x # to :: Rep Tls x -> 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 #
FromJSON Tls Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser Tls # parseJSONList :: Value -> Parser [Tls] #
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.4.0.5-inplace" '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

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 #
Generic Path Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep Path :: Type -> Type # Methods from :: Path -> Rep Path x # to :: Rep Path x -> 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 #
Monoid Path Source #
Instance details Defined in Polysemy.Http.Data.Request Methods mempty :: Path # mappend :: Path -> Path -> Path # mconcat :: [Path] -> 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 #
FromJSON Path Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser Path # parseJSONList :: Value -> Parser [Path] #
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.4.0.5-inplace" '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

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 #
Generic QueryKey Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep QueryKey :: Type -> Type # Methods from :: QueryKey -> Rep QueryKey x # to :: Rep QueryKey x -> 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 #
FromJSON QueryKey Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser QueryKey # parseJSONList :: Value -> Parser [QueryKey] #
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.4.0.5-inplace" '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

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 #
Generic QueryValue Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep QueryValue :: Type -> Type # Methods from :: QueryValue -> Rep QueryValue x # to :: Rep QueryValue x -> 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 #
FromJSON QueryValue Source #
Instance details Defined in Polysemy.Http.Data.Request Methods parseJSON :: Value -> Parser QueryValue # parseJSONList :: Value -> Parser [QueryValue] #
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.4.0.5-inplace" 'True) (C1 ('MetaCons "QueryValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "unQueryValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

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 #
Generic Body Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep Body :: Type -> Type # Methods from :: Body -> Rep Body x # to :: Rep Body x -> Body #
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.4.0.5-inplace" 'True) (C1 ('MetaCons "Body" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LByteString)))

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

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 #
Generic Request Source #
Instance details Defined in Polysemy.Http.Data.Request Associated Types type Rep Request :: Type -> Type # Methods from :: Request -> Rep Request x # to :: Rep Request x -> Request #
HasRequest Request Source #
Instance details Defined in Polysemy.Http.Data.Request Methods request :: Lens' Request Request Source # body :: Lens' Request Body Source # cookies :: Lens' Request CookieJar 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 #
type Rep Request Source #
Instance details Defined in Polysemy.Http.Data.Request type Rep Request = D1 ('MetaData "Request" "Polysemy.Http.Data.Request" "polysemy-http-0.4.0.5-inplace" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Method) :: S1 ('MetaSel ('Just "_host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Host)) :: (S1 ('MetaSel ('Just "_port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Port)) :: S1 ('MetaSel ('Just "_tls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tls))) :: ((S1 ('MetaSel ('Just "_path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Path) :: S1 ('MetaSel ('Just "_headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(HeaderName, HeaderValue)])) :: (S1 ('MetaSel ('Just "_cookies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CookieJar) :: (S1 ('MetaSel ('Just "_query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(QueryKey, Maybe QueryValue)]) :: S1 ('MetaSel ('Just "_body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Body))))))