Safe Haskell	None
Language	Haskell2010

Web.JobsUi.Internal.Types

Description

Defines types used throughout the app

Synopsis

data JobStatus
- = Done
- | Running
- | Waiting
newtype JobId = JobId {
- getJobId :: Int
}
data Job = Job {
- jobId :: JobId
- jobTimeQueued :: ZonedTime
- jobTimeStarted :: Maybe ZonedTime
- jobTimeEnded :: Maybe ZonedTime
- jobFinished :: Maybe (Result Text Text)
- jobThread :: Maybe ThreadId
- jobPayload :: info
- jobInfo :: JobInfo info
}
data JobsDS a = Jobs {
- waiting :: Seq a
- running :: Maybe a
- done :: [a]
}
type Jobs = JobsDS Job
type Action' ctx = SpockActionCtx ctx () () ServerState
type Action ctx a = SpockActionCtx ctx () () ServerState a
data ServerState = ServerState {
- myjobsVar :: TVar Jobs
- counterVar :: TVar Int
}
type Html = Html ()
noJobs :: Jobs
getJobType :: Job -> Text
getJobParams :: Job -> [Text]
data Result v a
- = Success a
- | Error v
data JobType = JobType {
- getJobInfo :: JobInfo a
}
data ParamInputType
- = TextInput
- | TextOptions (IO [Text])
data Param = Param {
- paramDesc :: Text
- paramInputType :: ParamInputType
- paramValidation :: Text -> IO (Result Text Text)
}
data JobInfo a = JobInfo {
- jiType :: Text
- jiInputs :: [Param]
- jiParams :: a -> [Text]
- jiConstructor :: [(Text, Text)] -> IO a
- jiExec :: a -> IO Text
- jiNotify :: a -> Result Text Text -> IO ()
}

Documentation

data JobStatus Source #

Constructors

Done
Running
Waiting

Instances

Eq JobStatus Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods (==) :: JobStatus -> JobStatus -> Bool # (/=) :: JobStatus -> JobStatus -> Bool #
Show JobStatus Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods showsPrec :: Int -> JobStatus -> ShowS # show :: JobStatus -> String # showList :: [JobStatus] -> ShowS #

newtype JobId Source #

Constructors

JobId
Fields getJobId :: Int

Instances

Eq JobId Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods (==) :: JobId -> JobId -> Bool # (/=) :: JobId -> JobId -> Bool #
Ord JobId Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods compare :: JobId -> JobId -> Ordering # (<) :: JobId -> JobId -> Bool # (<=) :: JobId -> JobId -> Bool # (>) :: JobId -> JobId -> Bool # (>=) :: JobId -> JobId -> Bool # max :: JobId -> JobId -> JobId # min :: JobId -> JobId -> JobId #
Show JobId Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods showsPrec :: Int -> JobId -> ShowS # show :: JobId -> String # showList :: [JobId] -> ShowS #

data Job Source #

Constructors

Job
Fields jobId :: JobId jobTimeQueued :: ZonedTime jobTimeStarted :: Maybe ZonedTime jobTimeEnded :: Maybe ZonedTime jobFinished :: Maybe (Result Text Text) jobThread :: Maybe ThreadId jobPayload :: info jobInfo :: JobInfo info

data JobsDS a Source #

Constructors

Jobs
Fields waiting :: Seq a running :: Maybe a done :: [a]

Instances

Functor JobsDS Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods fmap :: (a -> b) -> JobsDS a -> JobsDS b # (<$) :: a -> JobsDS b -> JobsDS a #
Foldable JobsDS Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods fold :: Monoid m => JobsDS m -> m # foldMap :: Monoid m => (a -> m) -> JobsDS a -> m # foldr :: (a -> b -> b) -> b -> JobsDS a -> b # foldr' :: (a -> b -> b) -> b -> JobsDS a -> b # foldl :: (b -> a -> b) -> b -> JobsDS a -> b # foldl' :: (b -> a -> b) -> b -> JobsDS a -> b # foldr1 :: (a -> a -> a) -> JobsDS a -> a # foldl1 :: (a -> a -> a) -> JobsDS a -> a # toList :: JobsDS a -> [a] # null :: JobsDS a -> Bool # length :: JobsDS a -> Int # elem :: Eq a => a -> JobsDS a -> Bool # maximum :: Ord a => JobsDS a -> a # minimum :: Ord a => JobsDS a -> a # sum :: Num a => JobsDS a -> a # product :: Num a => JobsDS a -> a #
Traversable JobsDS Source #
Instance details Defined in Web.JobsUi.Internal.Types Methods traverse :: Applicative f => (a -> f b) -> JobsDS a -> f (JobsDS b) # sequenceA :: Applicative f => JobsDS (f a) -> f (JobsDS a) # mapM :: Monad m => (a -> m b) -> JobsDS a -> m (JobsDS b) # sequence :: Monad m => JobsDS (m a) -> m (JobsDS a) #

type Jobs = JobsDS Job Source #

type Action' ctx = SpockActionCtx ctx () () ServerState Source #

type Action ctx a = SpockActionCtx ctx () () ServerState a Source #

data ServerState Source #

Constructors

ServerState
Fields myjobsVar :: TVar Jobs counterVar :: TVar Int

type Html = Html () Source #

noJobs :: Jobs Source #

getJobType :: Job -> Text Source #

getJobParams :: Job -> [Text] Source #

data Result v a #

A mostly internally used type for representing Success/Error, with a special applicative instance

Constructors

Success a
Error v

Instances

Monoid v => Monad (Result v)
Instance details Defined in Text.Digestive.Types Methods (>>=) :: Result v a -> (a -> Result v b) -> Result v b # (>>) :: Result v a -> Result v b -> Result v b # return :: a -> Result v a # fail :: String -> Result v a #
Functor (Result v)
Instance details Defined in Text.Digestive.Types Methods fmap :: (a -> b) -> Result v a -> Result v b # (<$) :: a -> Result v b -> Result v a #
Monoid v => Applicative (Result v)
Instance details Defined in Text.Digestive.Types Methods pure :: a -> Result v a # (<>) :: Result v (a -> b) -> Result v a -> Result v b # liftA2 :: (a -> b -> c) -> Result v a -> Result v b -> Result v c # (>) :: Result v a -> Result v b -> Result v b # (<*) :: Result v a -> Result v b -> Result v a #
(Show a, Show v) => Show (Result v a)
Instance details Defined in Text.Digestive.Types Methods showsPrec :: Int -> Result v a -> ShowS # show :: Result v a -> String # showList :: [Result v a] -> ShowS #

data JobType Source #

Existential type for job. Let's us ignore the job payload internally.

Constructors

JobType
Fields getJobInfo :: JobInfo a

data ParamInputType Source #

Input type

Constructors

TextInput
TextOptions (IO [Text])

data Param Source #

Defines a parameter for the user

Constructors

Param
Fields paramDesc :: Text paramInputType :: ParamInputType paramValidation :: Text -> IO (Result Text Text)

data JobInfo a Source #

JobInfo is a description a job a user can run @a@ is the structure built from the parameters.

Constructors

JobInfo

Fields

jiType :: Text
The name of the job type.
jiInputs :: [Param]
Definition of user parameters.
jiParams :: a -> [Text]
Conversion from the job payload structure to presentable parameters.
jiConstructor :: [(Text, Text)] -> IO a
Construct a payload type from user entered parameters.
jiExec :: a -> IO Text
How to execute a job. Returns a presentable Html when the job succeeds.
jiNotify :: a -> Result Text Text -> IO ()
Will be run when job ends.