Polysemy.Http.Data.Request

Documentation

data Method

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

FromJSON Method

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Method

parseJSONList :: Value -> Parser [Method]

ToJSON Method

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Method -> Value

toEncoding :: Method -> Encoding

toJSONList :: [Method] -> Value

toEncodingList :: [Method] -> Encoding

IsString Method

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Method

Show Method

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

Eq Method

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Method -> Method -> Bool

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

methodUpper :: Method -> Text

Produce the usual uppercase representation of a method.

newtype Host

Request host name.

Constructors

Host

Fields

• unHost :: Text

Instances

FromJSON Host

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Host

parseJSONList :: Value -> Parser [Host]

ToJSON Host

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Host -> Value

toEncoding :: Host -> Encoding

toJSONList :: [Host] -> Value

toEncodingList :: [Host] -> Encoding

IsString Host

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Host

Generic Host

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Host :: Type -> Type

Methods

from :: Host -> Rep Host x

to :: Rep Host x -> Host

Show Host

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Host -> ShowS

show :: Host -> String

showList :: [Host] -> ShowS

Eq Host

Defined in Polysemy.Http.Data.Request

Methods

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

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

type Rep Host

Defined in Polysemy.Http.Data.Request

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

newtype Port

Request port.

Constructors

Port

Fields

• unPort :: Int

Instances

FromJSON Port

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Port

parseJSONList :: Value -> Parser [Port]

ToJSON Port

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Port -> Value

toEncoding :: Port -> Encoding

toJSONList :: [Port] -> Value

toEncodingList :: [Port] -> Encoding

Enum Port

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

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Port :: Type -> Type

Methods

from :: Port -> Rep Port x

to :: Rep Port x -> Port

Num Port

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

Defined in Polysemy.Http.Data.Request

Methods

readsPrec :: Int -> ReadS Port

readList :: ReadS [Port]

readPrec :: ReadPrec Port

readListPrec :: ReadPrec [Port]

Integral Port

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

Defined in Polysemy.Http.Data.Request

Methods

toRational :: Port -> Rational

Show Port

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Port -> ShowS

show :: Port -> String

showList :: [Port] -> ShowS

Eq Port

Defined in Polysemy.Http.Data.Request

Methods

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

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

Ord Port

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

Defined in Polysemy.Http.Data.Request

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

newtype Tls

A flag that indicates whether a request should use TLS.

Constructors

Tls

Fields

• unTls :: Bool

Instances

FromJSON Tls

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Tls

parseJSONList :: Value -> Parser [Tls]

ToJSON Tls

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Tls -> Value

toEncoding :: Tls -> Encoding

toJSONList :: [Tls] -> Value

toEncodingList :: [Tls] -> Encoding

Generic Tls

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Tls :: Type -> Type

Methods

from :: Tls -> Rep Tls x

to :: Rep Tls x -> Tls

Show Tls

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Tls -> ShowS

show :: Tls -> String

showList :: [Tls] -> ShowS

Eq Tls

Defined in Polysemy.Http.Data.Request

Methods

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

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

type Rep Tls

Defined in Polysemy.Http.Data.Request

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

newtype Path

Rrequest path.

Constructors

Path

Fields

• unPath :: Text

Instances

FromJSON Path

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser Path

parseJSONList :: Value -> Parser [Path]

ToJSON Path

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: Path -> Value

toEncoding :: Path -> Encoding

toJSONList :: [Path] -> Value

toEncodingList :: [Path] -> Encoding

IsString Path

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Path

Monoid Path

Defined in Polysemy.Http.Data.Request

Methods

mempty :: Path

mappend :: Path -> Path -> Path

mconcat :: [Path] -> Path

Semigroup Path

Defined in Polysemy.Http.Data.Request

Methods

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

sconcat :: NonEmpty Path -> Path

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

Generic Path

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Path :: Type -> Type

Methods

from :: Path -> Rep Path x

to :: Rep Path x -> Path

Show Path

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Path -> ShowS

show :: Path -> String

showList :: [Path] -> ShowS

Eq Path

Defined in Polysemy.Http.Data.Request

Methods

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

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

type Rep Path

Defined in Polysemy.Http.Data.Request

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

newtype QueryKey

The key of a query parameter.

Constructors

QueryKey

Fields

• unQueryKey :: Text

Instances

FromJSON QueryKey

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser QueryKey

parseJSONList :: Value -> Parser [QueryKey]

ToJSON QueryKey

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: QueryKey -> Value

toEncoding :: QueryKey -> Encoding

toJSONList :: [QueryKey] -> Value

toEncodingList :: [QueryKey] -> Encoding

IsString QueryKey

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> QueryKey

Generic QueryKey

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep QueryKey :: Type -> Type

Methods

from :: QueryKey -> Rep QueryKey x

to :: Rep QueryKey x -> QueryKey

Show QueryKey

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> QueryKey -> ShowS

show :: QueryKey -> String

showList :: [QueryKey] -> ShowS

Eq QueryKey

Defined in Polysemy.Http.Data.Request

Methods

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

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

type Rep QueryKey

Defined in Polysemy.Http.Data.Request

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

newtype QueryValue

The value of a query parameter.

Constructors

QueryValue

Fields

• unQueryValue :: Text

Instances

FromJSON QueryValue

Defined in Polysemy.Http.Data.Request

Methods

parseJSON :: Value -> Parser QueryValue

parseJSONList :: Value -> Parser [QueryValue]

ToJSON QueryValue

Defined in Polysemy.Http.Data.Request

Methods

toJSON :: QueryValue -> Value

toEncoding :: QueryValue -> Encoding

toJSONList :: [QueryValue] -> Value

toEncodingList :: [QueryValue] -> Encoding

IsString QueryValue

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> QueryValue

Generic QueryValue

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep QueryValue :: Type -> Type

Methods

from :: QueryValue -> Rep QueryValue x

to :: Rep QueryValue x -> QueryValue

Show QueryValue

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> QueryValue -> ShowS

show :: QueryValue -> String

showList :: [QueryValue] -> ShowS

Eq QueryValue

Defined in Polysemy.Http.Data.Request

Methods

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

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

type Rep QueryValue

Defined in Polysemy.Http.Data.Request

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

newtype Body

Request body.

Constructors

Body

Fields

• unBody :: ByteString

Instances

IsString Body

Defined in Polysemy.Http.Data.Request

Methods

fromString :: String -> Body

Generic Body

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Body :: Type -> Type

Methods

from :: Body -> Rep Body x

to :: Rep Body x -> Body

Show Body

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Body -> ShowS

show :: Body -> String

showList :: [Body] -> ShowS

Eq Body

Defined in Polysemy.Http.Data.Request

Methods

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

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

type Rep Body

Defined in Polysemy.Http.Data.Request

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

data Request

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

Generic Request

Defined in Polysemy.Http.Data.Request

Associated Types

type Rep Request :: Type -> Type

Methods

from :: Request -> Rep Request x

to :: Rep Request x -> Request

Show Request

Defined in Polysemy.Http.Data.Request

Methods

showsPrec :: Int -> Request -> ShowS

show :: Request -> String

showList :: [Request] -> ShowS

Eq Request

Defined in Polysemy.Http.Data.Request

Methods

(==) :: Request -> Request -> Bool

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

type Rep Request

Defined in Polysemy.Http.Data.Request

type Rep Request = D1 ('MetaData "Request" "Polysemy.Http.Data.Request" "polysemy-http-0.11.0.0-KwdjpKcptzS4j0Fq88wQVf" '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))))))