Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Data.PluginConfig

Description

Global configuration for a Ribosome plugin.

Synopsis

data PluginConfig c = PluginConfig {
- name :: PluginName
- host :: HostConfig
- custom :: Parser c
}
pluginNamed :: PluginName -> PluginConfig ()

Documentation

data PluginConfig c Source #

The full configuration for a Ribosome plugin, consisting of the HostConfig, the plugin's name, and an arbitrary type for additional config defined by individual plugins.

Constructors

PluginConfig
Fields name :: PluginName host :: HostConfig custom :: Parser c

Instances

Instances details

IsString (PluginConfig ()) Source #
Instance details Defined in Ribosome.Data.PluginConfig Methods fromString :: String -> PluginConfig () #
Generic (PluginConfig c) Source #
Instance details Defined in Ribosome.Data.PluginConfig Associated Types type Rep (PluginConfig c) :: Type -> Type # Methods from :: PluginConfig c -> Rep (PluginConfig c) x # to :: Rep (PluginConfig c) x -> PluginConfig c #
Show (PluginConfig c) Source #
Instance details Defined in Ribosome.Data.PluginConfig Methods showsPrec :: Int -> PluginConfig c -> ShowS # show :: PluginConfig c -> String # showList :: [PluginConfig c] -> ShowS #
Eq (PluginConfig c) Source #
Instance details Defined in Ribosome.Data.PluginConfig Methods (==) :: PluginConfig c -> PluginConfig c -> Bool # (/=) :: PluginConfig c -> PluginConfig c -> Bool #
type Rep (PluginConfig c) Source #
Instance details Defined in Ribosome.Data.PluginConfig type Rep (PluginConfig c) = D1 ('MetaData "PluginConfig" "Ribosome.Data.PluginConfig" "ribosome-0.9.9.9-2kHabuyTX5NGSYChGwh5iS" 'False) (C1 ('MetaCons "PluginConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PluginName) :: (S1 ('MetaSel ('Just "host") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HostConfig) :: S1 ('MetaSel ('Just "custom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Parser c)))))

pluginNamed :: PluginName -> PluginConfig () Source #

Construct a simple PluginConfig with the default config for the host, given the plugin's name.