Hercules.API.Task

Documentation

data Task a

A task, typically performed by the agent.

The phantom represents the type of task. See AnyTask.

Constructors

Task

Fields

• typ :: Text
• id :: Id (Task a)

Instances

Eq (Task a)

Defined in Hercules.API.Task

Methods

(==) :: Task a -> Task a -> Bool

(/=) :: Task a -> Task a -> Bool

Show (Task a)

Defined in Hercules.API.Task

Methods

showsPrec :: Int -> Task a -> ShowS

show :: Task a -> String

showList :: [Task a] -> ShowS

Generic (Task a)

Defined in Hercules.API.Task

Associated Types

type Rep (Task a) :: Type -> Type

Methods

from :: Task a -> Rep (Task a) x

to :: Rep (Task a) x -> Task a

ToJSON (Task a)

Defined in Hercules.API.Task

Methods

toJSON :: Task a -> Value

toEncoding :: Task a -> Encoding

toJSONList :: [Task a] -> Value

toEncodingList :: [Task a] -> Encoding

FromJSON (Task a)

Defined in Hercules.API.Task

Methods

parseJSON :: Value -> Parser (Task a)

parseJSONList :: Value -> Parser [Task a]

ToSchema (Task a)

Defined in Hercules.API.Task

Methods

declareNamedSchema :: Proxy (Task a) -> Declare (Definitions Schema) NamedSchema

type Rep (Task a)

Defined in Hercules.API.Task

type Rep (Task a) = D1 (MetaData "Task" "Hercules.API.Task" "hercules-ci-api-agent-0.2.2.0-H8XBgIW1mHxGazLTBa2ark" False) (C1 (MetaCons "Task" PrefixI True) (S1 (MetaSel (Just "typ") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Id (Task a)))))

data Any

@Task Any represents tasks whose type has not yet been read.

upcast :: Task a -> Task Any

Safe type cast.

upcastId :: Id (Task a) -> Id (Task Any)

Safe type cast.

uncheckedCast :: Task a -> Task b