Safe Haskell	Safe-Inferred
Language	Haskell2010

Httpstan.Core

Contents

HttpstanConfig
HttpstanRequest
HasBodyParam
HasOptionalParam
- HttpstanRequest Utils
- Params Utils
  - OpenAPI CollectionFormat Utils
AuthMethods
Utils
DateTime Formatting
Date Formatting
Byte/Binary Formatting
Lens Type Aliases

Description

Synopsis

data HttpstanConfig = HttpstanConfig {
- configHost :: ByteString
- configUserAgent :: Text
- configLogExecWithContext :: LogExecWithContext
- configLogContext :: LogContext
- configAuthMethods :: [AnyAuthMethod]
- configValidateAuthMethods :: Bool
- configQueryExtraUnreserved :: ByteString
}
newConfig :: IO HttpstanConfig
addAuthMethod :: AuthMethod auth => HttpstanConfig -> auth -> HttpstanConfig
withStdoutLogging :: HttpstanConfig -> IO HttpstanConfig
withStderrLogging :: HttpstanConfig -> IO HttpstanConfig
withNoLogging :: HttpstanConfig -> HttpstanConfig
data HttpstanRequest req contentType res accept = HttpstanRequest {
- rMethod :: Method
- rUrlPath :: [ByteString]
- rParams :: Params
- rAuthTypes :: [TypeRep]
}
rMethodL :: Lens_' (HttpstanRequest req contentType res accept) Method
rUrlPathL :: Lens_' (HttpstanRequest req contentType res accept) [ByteString]
rParamsL :: Lens_' (HttpstanRequest req contentType res accept) Params
rAuthTypesL :: Lens_' (HttpstanRequest req contentType res accept) [TypeRep]
class HasBodyParam req param where
- setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => HttpstanRequest req contentType res accept -> param -> HttpstanRequest req contentType res accept
class HasOptionalParam req param where
- applyOptionalParam :: HttpstanRequest req contentType res accept -> param -> HttpstanRequest req contentType res accept
- (-&-) :: HttpstanRequest req contentType res accept -> param -> HttpstanRequest req contentType res accept
data Params = Params {
- paramsQuery :: Query
- paramsHeaders :: RequestHeaders
- paramsBody :: ParamBody
}
paramsQueryL :: Lens_' Params Query
paramsHeadersL :: Lens_' Params RequestHeaders
paramsBodyL :: Lens_' Params ParamBody
data ParamBody
- = ParamBodyNone
- | ParamBodyB ByteString
- | ParamBodyBL ByteString
- | ParamBodyFormUrlEncoded Form
- | ParamBodyMultipartFormData [Part]
_mkRequest :: Method -> [ByteString] -> HttpstanRequest req contentType res accept
_mkParams :: Params
setHeader :: HttpstanRequest req contentType res accept -> [Header] -> HttpstanRequest req contentType res accept
addHeader :: HttpstanRequest req contentType res accept -> [Header] -> HttpstanRequest req contentType res accept
removeHeader :: HttpstanRequest req contentType res accept -> [HeaderName] -> HttpstanRequest req contentType res accept
_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => HttpstanRequest req contentType res accept -> HttpstanRequest req contentType res accept
_setAcceptHeader :: forall req contentType res accept. MimeType accept => HttpstanRequest req contentType res accept -> HttpstanRequest req contentType res accept
setQuery :: HttpstanRequest req contentType res accept -> [QueryItem] -> HttpstanRequest req contentType res accept
addQuery :: HttpstanRequest req contentType res accept -> [QueryItem] -> HttpstanRequest req contentType res accept
addForm :: HttpstanRequest req contentType res accept -> Form -> HttpstanRequest req contentType res accept
_addMultiFormPart :: HttpstanRequest req contentType res accept -> Part -> HttpstanRequest req contentType res accept
_setBodyBS :: HttpstanRequest req contentType res accept -> ByteString -> HttpstanRequest req contentType res accept
_setBodyLBS :: HttpstanRequest req contentType res accept -> ByteString -> HttpstanRequest req contentType res accept
_hasAuthType :: AuthMethod authMethod => HttpstanRequest req contentType res accept -> Proxy authMethod -> HttpstanRequest req contentType res accept
toPath :: ToHttpApiData a => a -> ByteString
toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header]
toForm :: ToHttpApiData v => (ByteString, v) -> Form
toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem]
toPartialEscapeQuery :: ByteString -> Query -> PartialEscapeQuery
data CollectionFormat
- = CommaSeparated
- | SpaceSeparated
- | TabSeparated
- | PipeSeparated
- | MultiParamArray
toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header]
toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form
toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query
_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)]
_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)]
_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)]
class Typeable a => AuthMethod a where
- applyAuthMethod :: HttpstanConfig -> a -> HttpstanRequest req contentType res accept -> IO (HttpstanRequest req contentType res accept)
data AnyAuthMethod = forall a.AuthMethod a => AnyAuthMethod a
data AuthMethodException = AuthMethodException String
_applyAuthMethods :: HttpstanRequest req contentType res accept -> HttpstanConfig -> IO (HttpstanRequest req contentType res accept)
_omitNulls :: [(Key, Value)] -> Value
_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text])
_emptyToNothing :: Maybe String -> Maybe String
_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a
newtype DateTime = DateTime {
- unDateTime :: UTCTime
}
_readDateTime :: (MonadFail m, Alternative m) => String -> m DateTime
_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String
_parseISO8601 :: (ParseTime t, MonadFail m, Alternative m) => String -> m t
newtype Date = Date {
- unDate :: Day
}
_readDate :: MonadFail m => String -> m Date
_showDate :: FormatTime t => t -> String
newtype ByteArray = ByteArray {
- unByteArray :: ByteString
}
_readByteArray :: MonadFail m => Text -> m ByteArray
_showByteArray :: ByteArray -> Text
newtype Binary = Binary {
- unBinary :: ByteString
}
_readBinaryBase64 :: MonadFail m => Text -> m Binary
_showBinaryBase64 :: Binary -> Text
type Lens_' s a = Lens_ s s a a
type Lens_ s t a b = forall (f :: Type -> Type). Functor f => (a -> f b) -> s -> f t

HttpstanConfig

data HttpstanConfig Source #

Constructors

HttpstanConfig

Fields

configHost :: ByteString
host supplied in the Request
configUserAgent :: Text
user-agent supplied in the Request
configLogExecWithContext :: LogExecWithContext
Run a block using a Logger instance
configLogContext :: LogContext
Configures the logger
configAuthMethods :: [AnyAuthMethod]
List of configured auth methods
configValidateAuthMethods :: Bool
throw exceptions if auth methods are not configured
configQueryExtraUnreserved :: ByteString
Configures additional querystring characters which must not be URI encoded, e.g. + or :

Instances

Instances details

Show HttpstanConfig Source #	display the config
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> HttpstanConfig -> ShowS # show :: HttpstanConfig -> String # showList :: [HttpstanConfig] -> ShowS #

newConfig :: IO HttpstanConfig Source #

constructs a default HttpstanConfig

configHost:

http://localhost

configUserAgent:

"httpstan/0.1.0.0"

addAuthMethod :: AuthMethod auth => HttpstanConfig -> auth -> HttpstanConfig Source #

updates config use AuthMethod on matching requests

withStdoutLogging :: HttpstanConfig -> IO HttpstanConfig Source #

updates the config to use stdout logging

withStderrLogging :: HttpstanConfig -> IO HttpstanConfig Source #

updates the config to use stderr logging

withNoLogging :: HttpstanConfig -> HttpstanConfig Source #

updates the config to disable logging

HttpstanRequest

data HttpstanRequest req contentType res accept Source #

Represents a request.

Type Variables:

req - request operation
contentType - MimeType associated with request body
res - response model
accept - MimeType associated with response body

Constructors

HttpstanRequest
Fields rMethod :: Method Method of HttpstanRequest rUrlPath :: [ByteString] Endpoint of HttpstanRequest rParams :: Params params of HttpstanRequest rAuthTypes :: [TypeRep] types of auth methods

Instances

Instances details

Show (HttpstanRequest req contentType res accept) Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> HttpstanRequest req contentType res accept -> ShowS # show :: HttpstanRequest req contentType res accept -> String # showList :: [HttpstanRequest req contentType res accept] -> ShowS #

rMethodL :: Lens_' (HttpstanRequest req contentType res accept) Method Source #

rMethod Lens

rUrlPathL :: Lens_' (HttpstanRequest req contentType res accept) [ByteString] Source #

rUrlPath Lens

rParamsL :: Lens_' (HttpstanRequest req contentType res accept) Params Source #

rParams Lens

rAuthTypesL :: Lens_' (HttpstanRequest req contentType res accept) [TypeRep] Source #

rParams Lens

HasBodyParam

class HasBodyParam req param where Source #

Designates the body parameter of a request

Minimal complete definition

Nothing

Methods

setBodyParam :: forall contentType res accept. (Consumes req contentType, MimeRender contentType param) => HttpstanRequest req contentType res accept -> param -> HttpstanRequest req contentType res accept Source #

Instances

Instances details

HasBodyParam V1ModelsModelIdFitsPost CreateFitRequest Source #	Body Param "body" - Full stan::services function name and associated arguments to call with Stan model.
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsModelIdFitsPost contentType, MimeRender contentType CreateFitRequest) => HttpstanRequest V1ModelsModelIdFitsPost contentType res accept -> CreateFitRequest -> HttpstanRequest V1ModelsModelIdFitsPost contentType res accept Source #
HasBodyParam V1ModelsModelIdLogProbGradPost AdjustTransform Source #	Body Param "adjust_transform" - Boolean to control whether we apply a Jacobian adjust transform.
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsModelIdLogProbGradPost contentType, MimeRender contentType AdjustTransform) => HttpstanRequest V1ModelsModelIdLogProbGradPost contentType res accept -> AdjustTransform -> HttpstanRequest V1ModelsModelIdLogProbGradPost contentType res accept Source #
HasBodyParam V1ModelsModelIdLogProbPost AdjustTransform Source #	Body Param "adjust_transform" - Boolean to control whether we apply a Jacobian adjust transform.
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsModelIdLogProbPost contentType, MimeRender contentType AdjustTransform) => HttpstanRequest V1ModelsModelIdLogProbPost contentType res accept -> AdjustTransform -> HttpstanRequest V1ModelsModelIdLogProbPost contentType res accept Source #
HasBodyParam V1ModelsModelIdParamsPost ParamData Source #	Body Param "data" - Data for Stan Model. Needed to calculate param names and dimensions.
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsModelIdParamsPost contentType, MimeRender contentType ParamData) => HttpstanRequest V1ModelsModelIdParamsPost contentType res accept -> ParamData -> HttpstanRequest V1ModelsModelIdParamsPost contentType res accept Source #
HasBodyParam V1ModelsModelIdTransformInitsPost ConstrainedParameters Source #	Body Param "constrained_parameters" - Constrained parameter values and their specified context
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsModelIdTransformInitsPost contentType, MimeRender contentType ConstrainedParameters) => HttpstanRequest V1ModelsModelIdTransformInitsPost contentType res accept -> ConstrainedParameters -> HttpstanRequest V1ModelsModelIdTransformInitsPost contentType res accept Source #
HasBodyParam V1ModelsModelIdWriteArrayPost IncludeGqs Source #	Body Param "include_gqs" - Boolean to control whether we include generated quantities.
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsModelIdWriteArrayPost contentType, MimeRender contentType IncludeGqs) => HttpstanRequest V1ModelsModelIdWriteArrayPost contentType res accept -> IncludeGqs -> HttpstanRequest V1ModelsModelIdWriteArrayPost contentType res accept Source #
HasBodyParam V1ModelsPost CreateModelRequest Source #	Body Param "body" - Stan program code to compile
Instance details Defined in Httpstan.API.ApiDefault Methods setBodyParam :: (Consumes V1ModelsPost contentType, MimeRender contentType CreateModelRequest) => HttpstanRequest V1ModelsPost contentType res accept -> CreateModelRequest -> HttpstanRequest V1ModelsPost contentType res accept Source #

HasOptionalParam

class HasOptionalParam req param where Source #

Designates the optional parameters of a request

Minimal complete definition

applyOptionalParam | (-&-)

Methods

applyOptionalParam :: HttpstanRequest req contentType res accept -> param -> HttpstanRequest req contentType res accept Source #

Apply an optional parameter to a request

(-&-) :: HttpstanRequest req contentType res accept -> param -> HttpstanRequest req contentType res accept infixl 2 Source #

infix operator / alias for addOptionalParam

data Params Source #

Request Params

Constructors

Params
Fields paramsQuery :: Query paramsHeaders :: RequestHeaders paramsBody :: ParamBody

Instances

Instances details

Show Params Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> Params -> ShowS # show :: Params -> String # showList :: [Params] -> ShowS #

paramsQueryL :: Lens_' Params Query Source #

paramsQuery Lens

paramsHeadersL :: Lens_' Params RequestHeaders Source #

paramsHeaders Lens

paramsBodyL :: Lens_' Params ParamBody Source #

paramsBody Lens

data ParamBody Source #

Request Body

Constructors

ParamBodyNone
ParamBodyB ByteString
ParamBodyBL ByteString
ParamBodyFormUrlEncoded Form
ParamBodyMultipartFormData [Part]

Instances

Instances details

Show ParamBody Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> ParamBody -> ShowS # show :: ParamBody -> String # showList :: [ParamBody] -> ShowS #

HttpstanRequest Utils

_mkRequest Source #

Arguments

:: Method	Method
-> [ByteString]	Endpoint
-> HttpstanRequest req contentType res accept	req: Request Type, res: Response Type

_mkParams :: Params Source #

setHeader :: HttpstanRequest req contentType res accept -> [Header] -> HttpstanRequest req contentType res accept Source #

addHeader :: HttpstanRequest req contentType res accept -> [Header] -> HttpstanRequest req contentType res accept Source #

removeHeader :: HttpstanRequest req contentType res accept -> [HeaderName] -> HttpstanRequest req contentType res accept Source #

_setContentTypeHeader :: forall req contentType res accept. MimeType contentType => HttpstanRequest req contentType res accept -> HttpstanRequest req contentType res accept Source #

_setAcceptHeader :: forall req contentType res accept. MimeType accept => HttpstanRequest req contentType res accept -> HttpstanRequest req contentType res accept Source #

setQuery :: HttpstanRequest req contentType res accept -> [QueryItem] -> HttpstanRequest req contentType res accept Source #

addQuery :: HttpstanRequest req contentType res accept -> [QueryItem] -> HttpstanRequest req contentType res accept Source #

addForm :: HttpstanRequest req contentType res accept -> Form -> HttpstanRequest req contentType res accept Source #

_addMultiFormPart :: HttpstanRequest req contentType res accept -> Part -> HttpstanRequest req contentType res accept Source #

_setBodyBS :: HttpstanRequest req contentType res accept -> ByteString -> HttpstanRequest req contentType res accept Source #

_setBodyLBS :: HttpstanRequest req contentType res accept -> ByteString -> HttpstanRequest req contentType res accept Source #

_hasAuthType :: AuthMethod authMethod => HttpstanRequest req contentType res accept -> Proxy authMethod -> HttpstanRequest req contentType res accept Source #

Params Utils

toPath :: ToHttpApiData a => a -> ByteString Source #

toHeader :: ToHttpApiData a => (HeaderName, a) -> [Header] Source #

toForm :: ToHttpApiData v => (ByteString, v) -> Form Source #

toQuery :: ToHttpApiData a => (ByteString, Maybe a) -> [QueryItem] Source #

toPartialEscapeQuery :: ByteString -> Query -> PartialEscapeQuery Source #

OpenAPI `CollectionFormat` Utils

data CollectionFormat Source #

Determines the format of the array if type array is used.

Constructors

CommaSeparated	CSV format for multiple parameters.
SpaceSeparated	Also called SSV
TabSeparated	Also called TSV
PipeSeparated	`value1\|value2\|value2`
MultiParamArray	Using multiple GET parameters, e.g. `foo=bar&foo=baz`. This is valid only for parameters in "query" (`Query`) or "formData" (`Form`)

toHeaderColl :: ToHttpApiData a => CollectionFormat -> (HeaderName, [a]) -> [Header] Source #

toFormColl :: ToHttpApiData v => CollectionFormat -> (ByteString, [v]) -> Form Source #

toQueryColl :: ToHttpApiData a => CollectionFormat -> (ByteString, Maybe [a]) -> Query Source #

_toColl :: Traversable f => CollectionFormat -> (f a -> [(b, ByteString)]) -> f [a] -> [(b, ByteString)] Source #

_toCollA :: (Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t ByteString)]) -> f (t [a]) -> [(b, t ByteString)] Source #

_toCollA' :: (Monoid c, Traversable f, Traversable t, Alternative t) => CollectionFormat -> (f (t a) -> [(b, t c)]) -> (Char -> c) -> f (t [a]) -> [(b, t c)] Source #

AuthMethods

class Typeable a => AuthMethod a where Source #

Provides a method to apply auth methods to requests

Methods

applyAuthMethod :: HttpstanConfig -> a -> HttpstanRequest req contentType res accept -> IO (HttpstanRequest req contentType res accept) Source #

Instances

Instances details

AuthMethod AnyAuthMethod Source #
Instance details Defined in Httpstan.Core Methods applyAuthMethod :: HttpstanConfig -> AnyAuthMethod -> HttpstanRequest req contentType res accept -> IO (HttpstanRequest req contentType res accept) Source #

data AnyAuthMethod Source #

An existential wrapper for any AuthMethod

Constructors

forall a.AuthMethod a => AnyAuthMethod a

Instances

Instances details

AuthMethod AnyAuthMethod Source #
Instance details Defined in Httpstan.Core Methods applyAuthMethod :: HttpstanConfig -> AnyAuthMethod -> HttpstanRequest req contentType res accept -> IO (HttpstanRequest req contentType res accept) Source #

data AuthMethodException Source #

indicates exceptions related to AuthMethods

Constructors

AuthMethodException String

Instances

Instances details

Exception AuthMethodException Source #
Instance details Defined in Httpstan.Core Methods toException :: AuthMethodException -> SomeException # fromException :: SomeException -> Maybe AuthMethodException # displayException :: AuthMethodException -> String #
Show AuthMethodException Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> AuthMethodException -> ShowS # show :: AuthMethodException -> String # showList :: [AuthMethodException] -> ShowS #

_applyAuthMethods :: HttpstanRequest req contentType res accept -> HttpstanConfig -> IO (HttpstanRequest req contentType res accept) Source #

apply all matching AuthMethods in config to request

Utils

_omitNulls :: [(Key, Value)] -> Value Source #

Removes Null fields. (OpenAPI-Specification 2.0 does not allow Null in JSON)

_toFormItem :: (ToHttpApiData a, Functor f) => t -> f a -> f (t, [Text]) Source #

Encodes fields using WH.toQueryParam

_emptyToNothing :: Maybe String -> Maybe String Source #

Collapse (Just "") to Nothing

_memptyToNothing :: (Monoid a, Eq a) => Maybe a -> Maybe a Source #

Collapse (Just mempty) to Nothing

DateTime Formatting

newtype DateTime Source #

Constructors

DateTime
Fields unDateTime :: UTCTime

Instances

Instances details

Data DateTime Source #
Instance details Defined in Httpstan.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateTime -> c DateTime # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateTime # toConstr :: DateTime -> Constr # dataTypeOf :: DateTime -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateTime) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateTime) # gmapT :: (forall b. Data b => b -> b) -> DateTime -> DateTime # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateTime -> r # gmapQ :: (forall d. Data d => d -> u) -> DateTime -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DateTime -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateTime -> m DateTime #
Show DateTime Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> DateTime -> ShowS # show :: DateTime -> String # showList :: [DateTime] -> ShowS #
NFData DateTime Source #
Instance details Defined in Httpstan.Core Methods rnf :: DateTime -> () #
Eq DateTime Source #
Instance details Defined in Httpstan.Core Methods (==) :: DateTime -> DateTime -> Bool # (/=) :: DateTime -> DateTime -> Bool #
Ord DateTime Source #
Instance details Defined in Httpstan.Core Methods compare :: DateTime -> DateTime -> Ordering # (<) :: DateTime -> DateTime -> Bool # (<=) :: DateTime -> DateTime -> Bool # (>) :: DateTime -> DateTime -> Bool # (>=) :: DateTime -> DateTime -> Bool # max :: DateTime -> DateTime -> DateTime # min :: DateTime -> DateTime -> DateTime #
FromHttpApiData DateTime Source #
Instance details Defined in Httpstan.Core Methods parseUrlPiece :: Text -> Either Text DateTime # parseHeader :: ByteString -> Either Text DateTime # parseQueryParam :: Text -> Either Text DateTime #
ToHttpApiData DateTime Source #
Instance details Defined in Httpstan.Core Methods toUrlPiece :: DateTime -> Text # toEncodedUrlPiece :: DateTime -> Builder # toHeader :: DateTime -> ByteString # toQueryParam :: DateTime -> Text #
FromJSON DateTime Source #
Instance details Defined in Httpstan.Core Methods parseJSON :: Value -> Parser DateTime # parseJSONList :: Value -> Parser [DateTime] #
ToJSON DateTime Source #
Instance details Defined in Httpstan.Core Methods toJSON :: DateTime -> Value # toEncoding :: DateTime -> Encoding # toJSONList :: [DateTime] -> Value # toEncodingList :: [DateTime] -> Encoding #
MimeRender MimeMultipartFormData DateTime Source #
Instance details Defined in Httpstan.Core Methods mimeRender :: Proxy MimeMultipartFormData -> DateTime -> ByteString Source # mimeRender' :: MimeMultipartFormData -> DateTime -> ByteString Source #

_readDateTime :: (MonadFail m, Alternative m) => String -> m DateTime Source #

_parseISO8601

_showDateTime :: (t ~ UTCTime, FormatTime t) => t -> String Source #

TI.formatISO8601Millis

_parseISO8601 :: (ParseTime t, MonadFail m, Alternative m) => String -> m t Source #

parse an ISO8601 date-time string

Date Formatting

newtype Date Source #

Constructors

Date
Fields unDate :: Day

Instances

Instances details

Data Date Source #
Instance details Defined in Httpstan.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # toConstr :: Date -> Constr # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date #
Enum Date Source #
Instance details Defined in Httpstan.Core Methods succ :: Date -> Date # pred :: Date -> Date # toEnum :: Int -> Date # fromEnum :: Date -> Int # enumFrom :: Date -> [Date] # enumFromThen :: Date -> Date -> [Date] # enumFromTo :: Date -> Date -> [Date] # enumFromThenTo :: Date -> Date -> Date -> [Date] #
Ix Date Source #
Instance details Defined in Httpstan.Core Methods range :: (Date, Date) -> [Date] # index :: (Date, Date) -> Date -> Int # unsafeIndex :: (Date, Date) -> Date -> Int # inRange :: (Date, Date) -> Date -> Bool # rangeSize :: (Date, Date) -> Int # unsafeRangeSize :: (Date, Date) -> Int #
Show Date Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> Date -> ShowS # show :: Date -> String # showList :: [Date] -> ShowS #
NFData Date Source #
Instance details Defined in Httpstan.Core Methods rnf :: Date -> () #
Eq Date Source #
Instance details Defined in Httpstan.Core Methods (==) :: Date -> Date -> Bool # (/=) :: Date -> Date -> Bool #
Ord Date Source #
Instance details Defined in Httpstan.Core Methods compare :: Date -> Date -> Ordering # (<) :: Date -> Date -> Bool # (<=) :: Date -> Date -> Bool # (>) :: Date -> Date -> Bool # (>=) :: Date -> Date -> Bool # max :: Date -> Date -> Date # min :: Date -> Date -> Date #
FromHttpApiData Date Source #
Instance details Defined in Httpstan.Core Methods parseUrlPiece :: Text -> Either Text Date # parseHeader :: ByteString -> Either Text Date # parseQueryParam :: Text -> Either Text Date #
ToHttpApiData Date Source #
Instance details Defined in Httpstan.Core Methods toUrlPiece :: Date -> Text # toEncodedUrlPiece :: Date -> Builder # toHeader :: Date -> ByteString # toQueryParam :: Date -> Text #
FromJSON Date Source #
Instance details Defined in Httpstan.Core Methods parseJSON :: Value -> Parser Date # parseJSONList :: Value -> Parser [Date] #
ToJSON Date Source #
Instance details Defined in Httpstan.Core Methods toJSON :: Date -> Value # toEncoding :: Date -> Encoding # toJSONList :: [Date] -> Value # toEncodingList :: [Date] -> Encoding #
MimeRender MimeMultipartFormData Date Source #
Instance details Defined in Httpstan.Core Methods mimeRender :: Proxy MimeMultipartFormData -> Date -> ByteString Source # mimeRender' :: MimeMultipartFormData -> Date -> ByteString Source #

_readDate :: MonadFail m => String -> m Date Source #

TI.parseTimeM True TI.defaultTimeLocale "%Y-%m-%d"

_showDate :: FormatTime t => t -> String Source #

TI.formatTime TI.defaultTimeLocale "%Y-%m-%d"

Byte/Binary Formatting

newtype ByteArray Source #

base64 encoded characters

Constructors

ByteArray
Fields unByteArray :: ByteString

Instances

Instances details

Data ByteArray Source #
Instance details Defined in Httpstan.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ByteArray -> c ByteArray # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ByteArray # toConstr :: ByteArray -> Constr # dataTypeOf :: ByteArray -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ByteArray) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ByteArray) # gmapT :: (forall b. Data b => b -> b) -> ByteArray -> ByteArray # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ByteArray -> r # gmapQ :: (forall d. Data d => d -> u) -> ByteArray -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ByteArray -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ByteArray -> m ByteArray #
Show ByteArray Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> ByteArray -> ShowS # show :: ByteArray -> String # showList :: [ByteArray] -> ShowS #
NFData ByteArray Source #
Instance details Defined in Httpstan.Core Methods rnf :: ByteArray -> () #
Eq ByteArray Source #
Instance details Defined in Httpstan.Core Methods (==) :: ByteArray -> ByteArray -> Bool # (/=) :: ByteArray -> ByteArray -> Bool #
Ord ByteArray Source #
Instance details Defined in Httpstan.Core Methods compare :: ByteArray -> ByteArray -> Ordering # (<) :: ByteArray -> ByteArray -> Bool # (<=) :: ByteArray -> ByteArray -> Bool # (>) :: ByteArray -> ByteArray -> Bool # (>=) :: ByteArray -> ByteArray -> Bool # max :: ByteArray -> ByteArray -> ByteArray # min :: ByteArray -> ByteArray -> ByteArray #
FromHttpApiData ByteArray Source #
Instance details Defined in Httpstan.Core Methods parseUrlPiece :: Text -> Either Text ByteArray # parseHeader :: ByteString -> Either Text ByteArray # parseQueryParam :: Text -> Either Text ByteArray #
ToHttpApiData ByteArray Source #
Instance details Defined in Httpstan.Core Methods toUrlPiece :: ByteArray -> Text # toEncodedUrlPiece :: ByteArray -> Builder # toHeader :: ByteArray -> ByteString # toQueryParam :: ByteArray -> Text #
FromJSON ByteArray Source #
Instance details Defined in Httpstan.Core Methods parseJSON :: Value -> Parser ByteArray # parseJSONList :: Value -> Parser [ByteArray] #
ToJSON ByteArray Source #
Instance details Defined in Httpstan.Core Methods toJSON :: ByteArray -> Value # toEncoding :: ByteArray -> Encoding # toJSONList :: [ByteArray] -> Value # toEncodingList :: [ByteArray] -> Encoding #
MimeRender MimeMultipartFormData ByteArray Source #
Instance details Defined in Httpstan.Core Methods mimeRender :: Proxy MimeMultipartFormData -> ByteArray -> ByteString Source # mimeRender' :: MimeMultipartFormData -> ByteArray -> ByteString Source #

_readByteArray :: MonadFail m => Text -> m ByteArray Source #

read base64 encoded characters

_showByteArray :: ByteArray -> Text Source #

show base64 encoded characters

newtype Binary Source #

any sequence of octets

Constructors

Binary
Fields unBinary :: ByteString

Instances

Instances details

Data Binary Source #
Instance details Defined in Httpstan.Core Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Binary -> c Binary # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Binary # toConstr :: Binary -> Constr # dataTypeOf :: Binary -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Binary) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Binary) # gmapT :: (forall b. Data b => b -> b) -> Binary -> Binary # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Binary -> r # gmapQ :: (forall d. Data d => d -> u) -> Binary -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Binary -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Binary -> m Binary # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Binary -> m Binary #
Show Binary Source #
Instance details Defined in Httpstan.Core Methods showsPrec :: Int -> Binary -> ShowS # show :: Binary -> String # showList :: [Binary] -> ShowS #
NFData Binary Source #
Instance details Defined in Httpstan.Core Methods rnf :: Binary -> () #
Eq Binary Source #
Instance details Defined in Httpstan.Core Methods (==) :: Binary -> Binary -> Bool # (/=) :: Binary -> Binary -> Bool #
Ord Binary Source #
Instance details Defined in Httpstan.Core Methods compare :: Binary -> Binary -> Ordering # (<) :: Binary -> Binary -> Bool # (<=) :: Binary -> Binary -> Bool # (>) :: Binary -> Binary -> Bool # (>=) :: Binary -> Binary -> Bool # max :: Binary -> Binary -> Binary # min :: Binary -> Binary -> Binary #
FromHttpApiData Binary Source #
Instance details Defined in Httpstan.Core Methods parseUrlPiece :: Text -> Either Text Binary # parseHeader :: ByteString -> Either Text Binary # parseQueryParam :: Text -> Either Text Binary #
ToHttpApiData Binary Source #
Instance details Defined in Httpstan.Core Methods toUrlPiece :: Binary -> Text # toEncodedUrlPiece :: Binary -> Builder # toHeader :: Binary -> ByteString # toQueryParam :: Binary -> Text #
FromJSON Binary Source #
Instance details Defined in Httpstan.Core Methods parseJSON :: Value -> Parser Binary # parseJSONList :: Value -> Parser [Binary] #
ToJSON Binary Source #
Instance details Defined in Httpstan.Core Methods toJSON :: Binary -> Value # toEncoding :: Binary -> Encoding # toJSONList :: [Binary] -> Value # toEncodingList :: [Binary] -> Encoding #
MimeRender MimeMultipartFormData Binary Source #
Instance details Defined in Httpstan.Core Methods mimeRender :: Proxy MimeMultipartFormData -> Binary -> ByteString Source # mimeRender' :: MimeMultipartFormData -> Binary -> ByteString Source #

_readBinaryBase64 :: MonadFail m => Text -> m Binary Source #

_showBinaryBase64 :: Binary -> Text Source #

Lens Type Aliases

type Lens_' s a = Lens_ s s a a Source #

type Lens_ s t a b = forall (f :: Type -> Type). Functor f => (a -> f b) -> s -> f t Source #

HttpstanConfig

Instances

HttpstanRequest

Instances

HasBodyParam

Instances

HasOptionalParam

Instances

Instances

HttpstanRequest Utils

Params Utils

OpenAPI CollectionFormat Utils

AuthMethods

Instances

Instances

Instances

Utils

DateTime Formatting

Instances

Date Formatting

Instances

Byte/Binary Formatting

Instances

Instances

Lens Type Aliases

OpenAPI `CollectionFormat` Utils