Safe Haskell	None
Language	GHC2024

Arbiter.Core.Job.Kind

Description

A payload's variant label, stored on the job row for filtering and grouping.

Synopsis

class HasKind payload where
- kindOf :: payload -> Maybe Text
- kindsFor :: [Text]
constructorKind :: (GKindOf (Rep a), Generic a) => a -> Text
constructorKinds :: GKindsOf (Rep a) => [Text]
class GKindOf (f :: k -> Type) where
- gKindOf :: forall (a :: k). f a -> Text
class GKindsOf (f :: k) where
- gKindsOf :: [Text]

Documentation

Source #class HasKind payload where

A payload's per-job variant label. Defaults to unlabelled.

Minimal complete definition

Nothing

Methods

The label stored for a job.

Source #default kindOf :: (GKindOf (Rep payload), Generic payload) => payload -> Maybe Text

Every label kindOf can return. Empty when the set is not known.

Instances details

HasKind payload Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #kindOf :: payload -> Maybe Text Source #kindsFor :: [Text]

The constructor name of a value, for a payload that wraps the sum it wants labelled. Needs Generic on the wrapped type.

instance HasKind Envelope where
  kindOf = Just . constructorKind . envelopePayload
  kindsFor = constructorKinds @EmailPayload

Every constructor name of a type, in declaration order.

Source #class GKindOf (f :: k -> Type) where

The constructor name of a generic value.

Methods

Source #gKindOf :: forall (a :: k). f a -> Text

Instances details

GKindOf (V1 :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindOf :: forall (a :: k). V1 a -> Text
(GKindOf f, GKindOf g) => GKindOf (f :+: g :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindOf :: forall (a :: k). (f :+: g) a -> Text
KnownSymbol n => GKindOf (C1 ('MetaCons n fx s) f :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindOf :: forall (a :: k). C1 ('MetaCons n fx s) f a -> Text
GKindOf f => GKindOf (D1 d f :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindOf :: forall (a :: k). D1 d f a -> Text

Source #class GKindsOf (f :: k) where

Every constructor name of a generic representation, in declaration order.

Methods

Instances details

GKindsOf (V1 :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindsOf :: [Text]
(GKindsOf f, GKindsOf g) => GKindsOf (f :+: g :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindsOf :: [Text]
KnownSymbol n => GKindsOf (C1 ('MetaCons n fx s) f :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindsOf :: [Text]
GKindsOf f => GKindsOf (D1 d f :: k -> Type) Source #
Instance details Defined in Arbiter.Core.Job.Kind Methods Source #gKindsOf :: [Text]