Observe.Event.Servant.Client

This module offers a variant of servant-client's ClientM which instruments all requests with Events. It also has miscellaneous helpers for instrumenting servant-client functionality in other ways.

ClientM

newtype ClientM r a

A monad to use in place of ClientM to get instrumentation on requests.

Constructors

ClientM (ReaderT (EventBackend ClientM r RunRequest) ClientM a)

Instances

MonadBaseControl IO (ClientM r)

Defined in Observe.Event.Servant.Client

Associated Types

type StM (ClientM r) a

Methods

liftBaseWith :: (RunInBase (ClientM r) IO -> IO a) -> ClientM r a

restoreM :: StM (ClientM r) a -> ClientM r a

MonadError ClientError (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

throwError :: ClientError -> ClientM r a

catchError :: ClientM r a -> (ClientError -> ClientM r a) -> ClientM r a

MonadBase IO (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

liftBase :: IO α -> ClientM r α

MonadIO (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

liftIO :: IO a -> ClientM r a

Applicative (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

pure :: a -> ClientM r a

(<*>) :: ClientM r (a -> b) -> ClientM r a -> ClientM r b

liftA2 :: (a -> b -> c) -> ClientM r a -> ClientM r b -> ClientM r c

(*>) :: ClientM r a -> ClientM r b -> ClientM r b

(<*) :: ClientM r a -> ClientM r b -> ClientM r a

Functor (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

fmap :: (a -> b) -> ClientM r a -> ClientM r b

(<$) :: a -> ClientM r b -> ClientM r a

Monad (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

(>>=) :: ClientM r a -> (a -> ClientM r b) -> ClientM r b

(>>) :: ClientM r a -> ClientM r b -> ClientM r b

return :: a -> ClientM r a

MonadCatch (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

catch :: Exception e => ClientM r a -> (e -> ClientM r a) -> ClientM r a

MonadThrow (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

throwM :: Exception e => e -> ClientM r a

Alt (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

(<!>) :: ClientM r a -> ClientM r a -> ClientM r a

some :: Applicative (ClientM r) => ClientM r a -> ClientM r [a]

many :: Applicative (ClientM r) => ClientM r a -> ClientM r [a]

RunClient (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

runRequestAcceptStatus :: Maybe [Status] -> Request -> ClientM r Response

throwClientError :: ClientError -> ClientM r a

Generic (ClientM r a)

Defined in Observe.Event.Servant.Client

Associated Types

type Rep (ClientM r a) :: Type -> Type

Methods

from :: ClientM r a -> Rep (ClientM r a) x

to :: Rep (ClientM r a) x -> ClientM r a

MonadReader (EventBackend ClientM r RunRequest) (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

ask :: ClientM r (EventBackend ClientM0 r RunRequest)

local :: (EventBackend ClientM0 r RunRequest -> EventBackend ClientM0 r RunRequest) -> ClientM r a -> ClientM r a

reader :: (EventBackend ClientM0 r RunRequest -> a) -> ClientM r a

type StM (ClientM r) a

Defined in Observe.Event.Servant.Client

type StM (ClientM r) a = Either ClientError a

type Rep (ClientM r a)

Defined in Observe.Event.Servant.Client

type Rep (ClientM r a) = D1 ('MetaData "ClientM" "Observe.Event.Servant.Client" "eventuo11y-batteries-0.2.0.1-BiLrpmNiACMGnKYb0b1vfE" 'True) (C1 ('MetaCons "ClientM" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReaderT (EventBackend ClientM r RunRequest) ClientM a))))

runClientM :: EventBackend ClientM r RunRequest -> ClientM r a -> ClientEnv -> IO (Either ClientError a)

Instrumented version of runClientM

Instrumentation

data RunRequest f where

Selector for events in ClientM

Constructors

RunRequest :: RunRequest RunRequestField

Instances

MonadReader (EventBackend ClientM r RunRequest) (ClientM r)

Defined in Observe.Event.Servant.Client

Methods

ask :: ClientM r (EventBackend ClientM0 r RunRequest)

local :: (EventBackend ClientM0 r RunRequest -> EventBackend ClientM0 r RunRequest) -> ClientM r a -> ClientM r a

reader :: (EventBackend ClientM0 r RunRequest -> a) -> ClientM r a

runRequestJSON :: RenderSelectorJSON RunRequest

Render a RunRequest and the fields of its selected events as JSON

data RunRequestField

A field for RunRequest events.

Constructors

ReqField Request

ResField Response

runRequestFieldJSON :: RenderFieldJSON RunRequestField

Render a RunRequestField as JSON.

Miscellaneous instrumentation

clientErrorJSON :: RenderFieldJSON ClientError

Render a ClientError, considered as an Event field, as JSON

responseJSON :: Response -> Bool -> Value

Render a Response as JSON, optionally forcing rendering the body even if it's large.