Okapi.Type

Documentation

type Path = [Text]

type Headers = [Header]

type QueryItem = (Text, Maybe Text)

type Query = [QueryItem]

data State

Constructors

State

Fields

• stateRequest :: Request
• stateRequestMethodParsed :: Bool
• stateRequestBodyParsed :: Bool

Instances

Monad m => MonadState State (OkapiT m)

Defined in Okapi.Type

Methods

get :: OkapiT m State

put :: State -> OkapiT m ()

state :: (State -> (a, State)) -> OkapiT m a

data Request

Constructors

Request

Fields

• requestMethod :: Method
• requestPath :: Path
• requestQuery :: Query
• requestBody :: IO ByteString
• requestHeaders :: Headers
• requestVault :: Vault

data Result

Constructors

ResultResponse Response

ResultFile File

ResultEventSource EventSource

data File

Constructors

File

Fields

• fileStatus :: Natural
• fileHeaders :: Headers
• filePath :: FilePath

data Response

Constructors

Response

Fields

• responseStatus :: Natural
• responseHeaders :: Headers
• responseBody :: ByteString

data Failure

Constructors

Skip

Error Response

Instances

Monad m => MonadError Failure (OkapiT m)

Defined in Okapi.Type

Methods

throwError :: Failure -> OkapiT m a

catchError :: OkapiT m a -> (Failure -> OkapiT m a) -> OkapiT m a

newtype OkapiT m a

Constructors

OkapiT

Fields

• unOkapiT :: ExceptT Failure (StateT State m) a

Instances

MonadTrans OkapiT

Defined in Okapi.Type

Methods

lift :: Monad m => m a -> OkapiT m a

Monad m => MonadState State (OkapiT m)

Defined in Okapi.Type

Methods

get :: OkapiT m State

put :: State -> OkapiT m ()

state :: (State -> (a, State)) -> OkapiT m a

MonadReader r m => MonadReader r (OkapiT m)

Defined in Okapi.Type

Methods

ask :: OkapiT m r

local :: (r -> r) -> OkapiT m a -> OkapiT m a

reader :: (r -> a) -> OkapiT m a

Monad m => MonadError Failure (OkapiT m)

Defined in Okapi.Type

Methods

throwError :: Failure -> OkapiT m a

catchError :: OkapiT m a -> (Failure -> OkapiT m a) -> OkapiT m a

Monad m => Monad (OkapiT m)

Defined in Okapi.Type

Methods

(>>=) :: OkapiT m a -> (a -> OkapiT m b) -> OkapiT m b

(>>) :: OkapiT m a -> OkapiT m b -> OkapiT m b

return :: a -> OkapiT m a

Functor m => Functor (OkapiT m)

Defined in Okapi.Type

Methods

fmap :: (a -> b) -> OkapiT m a -> OkapiT m b

(<$) :: a -> OkapiT m b -> OkapiT m a

Monad m => Applicative (OkapiT m)

Defined in Okapi.Type

Methods

pure :: a -> OkapiT m a

(<*>) :: OkapiT m (a -> b) -> OkapiT m a -> OkapiT m b

liftA2 :: (a -> b -> c) -> OkapiT m a -> OkapiT m b -> OkapiT m c

(*>) :: OkapiT m a -> OkapiT m b -> OkapiT m b

(<*) :: OkapiT m a -> OkapiT m b -> OkapiT m a

Monad m => Alternative (OkapiT m)

Defined in Okapi.Type

Methods

empty :: OkapiT m a

(<|>) :: OkapiT m a -> OkapiT m a -> OkapiT m a

some :: OkapiT m a -> OkapiT m [a]

many :: OkapiT m a -> OkapiT m [a]

Monad m => MonadPlus (OkapiT m)

Defined in Okapi.Type

Methods

mzero :: OkapiT m a

mplus :: OkapiT m a -> OkapiT m a -> OkapiT m a

MonadIO m => MonadIO (OkapiT m)

Defined in Okapi.Type

Methods

liftIO :: IO a -> OkapiT m a

MFunctor OkapiT

Defined in Okapi.Type

Methods

hoist :: forall m n (b :: k). Monad m => (forall a. m a -> n a) -> OkapiT m b -> OkapiT n b

type MonadOkapi m = (Functor m, Applicative m, Alternative m, Monad m, MonadPlus m, MonadIO m, MonadError Failure m, MonadState State m)