Imm.Callback

Documentation

data Callback

External program run for each feed element.

Data is passed to that program through standard input (stdin).

Constructors

Callback

Fields

• _executable :: FilePath
• _arguments :: [Text]

Instances

Generic Callback

Defined in Imm.Callback

Associated Types

type Rep Callback :: Type -> Type

Methods

from :: Callback -> Rep Callback x

to :: Rep Callback x -> Callback

Read Callback

Defined in Imm.Callback

Methods

readsPrec :: Int -> ReadS Callback

readList :: ReadS [Callback]

readPrec :: ReadPrec Callback

readListPrec :: ReadPrec [Callback]

Show Callback

Defined in Imm.Callback

Methods

showsPrec :: Int -> Callback -> ShowS

show :: Callback -> String

showList :: [Callback] -> ShowS

FromDhall Callback

Defined in Imm.Callback

Methods

autoWith :: InputNormalizer -> Decoder Callback

Eq Callback

Defined in Imm.Callback

Methods

(==) :: Callback -> Callback -> Bool

(/=) :: Callback -> Callback -> Bool

Ord Callback

Defined in Imm.Callback

Methods

compare :: Callback -> Callback -> Ordering

(<) :: Callback -> Callback -> Bool

(<=) :: Callback -> Callback -> Bool

(>) :: Callback -> Callback -> Bool

(>=) :: Callback -> Callback -> Bool

max :: Callback -> Callback -> Callback

min :: Callback -> Callback -> Callback

Pretty Callback

Defined in Imm.Callback

Methods

pretty :: Callback -> Doc ann

prettyList :: [Callback] -> Doc ann

type Rep Callback

Defined in Imm.Callback

type Rep Callback = D1 ('MetaData "Callback" "Imm.Callback" "imm-2.1.3.0-D3c8Vn1SRDNHimeVgBOHyG" 'False) (C1 ('MetaCons "Callback" 'PrefixI 'True) (S1 ('MetaSel ('Just "_executable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "_arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

data CallbackMessage

Data structure passed to the external program, through JSON format.

The data schema is described in file schema/imm.json, provided with this library.

Constructors

CallbackMessage

Fields

• _callbackFeedLocation :: FeedLocation
• _callbackFeedDefinition :: FeedDefinition
• _callbackFeedItem :: FeedItem

Instances

FromJSON CallbackMessage

Defined in Imm.Callback

Methods

parseJSON :: Value -> Parser CallbackMessage

parseJSONList :: Value -> Parser [CallbackMessage]

omittedField :: Maybe CallbackMessage

ToJSON CallbackMessage

Defined in Imm.Callback

Methods

toJSON :: CallbackMessage -> Value

toEncoding :: CallbackMessage -> Encoding

toJSONList :: [CallbackMessage] -> Value

toEncodingList :: [CallbackMessage] -> Encoding

omitField :: CallbackMessage -> Bool

Generic CallbackMessage

Defined in Imm.Callback

Associated Types

type Rep CallbackMessage :: Type -> Type

Methods

from :: CallbackMessage -> Rep CallbackMessage x

to :: Rep CallbackMessage x -> CallbackMessage

Show CallbackMessage

Defined in Imm.Callback

Methods

showsPrec :: Int -> CallbackMessage -> ShowS

show :: CallbackMessage -> String

showList :: [CallbackMessage] -> ShowS

Eq CallbackMessage

Defined in Imm.Callback

Methods

(==) :: CallbackMessage -> CallbackMessage -> Bool

(/=) :: CallbackMessage -> CallbackMessage -> Bool

Ord CallbackMessage

Defined in Imm.Callback

Methods

compare :: CallbackMessage -> CallbackMessage -> Ordering

(<) :: CallbackMessage -> CallbackMessage -> Bool

(<=) :: CallbackMessage -> CallbackMessage -> Bool

(>) :: CallbackMessage -> CallbackMessage -> Bool

(>=) :: CallbackMessage -> CallbackMessage -> Bool

max :: CallbackMessage -> CallbackMessage -> CallbackMessage

min :: CallbackMessage -> CallbackMessage -> CallbackMessage

Pretty (PrettyShort CallbackMessage)

Defined in Imm.Callback

Methods

pretty :: PrettyShort CallbackMessage -> Doc ann

prettyList :: [PrettyShort CallbackMessage] -> Doc ann

type Rep CallbackMessage

Defined in Imm.Callback

type Rep CallbackMessage = D1 ('MetaData "CallbackMessage" "Imm.Callback" "imm-2.1.3.0-D3c8Vn1SRDNHimeVgBOHyG" 'False) (C1 ('MetaCons "CallbackMessage" 'PrefixI 'True) (S1 ('MetaSel ('Just "_callbackFeedLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FeedLocation) :*: (S1 ('MetaSel ('Just "_callbackFeedDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FeedDefinition) :*: S1 ('MetaSel ('Just "_callbackFeedItem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FeedItem))))

runCallback :: MonadIO m => Handle m -> Callback -> CallbackMessage -> m (Either (Callback, Int, LByteString, LByteString) (Callback, LByteString, LByteString))