Safe Haskell	Safe-Inferred
Language	Haskell2010

CalamityCommands.Command

Description

Commands and stuff

Synopsis

data Command (m :: Type -> Type) (c :: Type) (a :: Type) = forall p.Command {
- names :: NonEmpty Text
- parent :: Maybe (Group m c a)
- hidden :: Bool
- checks :: [Check m c]
- params :: [ParameterInfo]
- help :: c -> Text
- parser :: c -> m (Either CommandError p)
- callback :: (c, p) -> m (Either Text a)
}

Documentation

data Command (m :: Type -> Type) (c :: Type) (a :: Type) Source #

A command, paremeterised over its context

Constructors

forall p. Command

Fields

names :: NonEmpty Text
parent :: Maybe (Group m c a)
hidden :: Bool
If this command is hidden
checks :: [Check m c]
A list of checks that must pass for this command to be invoked
params :: [ParameterInfo]
A list of parameter metadata
help :: c -> Text
A function producing the 'help' for the command.
parser :: c -> m (Either CommandError p)
A function that parses the context for the command, producing the input a for the command.
callback :: (c, p) -> m (Either Text a)
A function that given the context and the input (p) of the command, performs the action of the command.

Instances

Instances details

(k ~ A_Lens, a1 ~ [Check m c], b ~ [Check m c]) => LabelOptic "checks" k (Command m c a2) (Command m c a2) a1 b Source #
Instance details Defined in CalamityCommands.Command Methods labelOptic :: Optic k NoIx (Command m c a2) (Command m c a2) a1 b #
(k ~ A_Lens, a1 ~ (c -> Text), b ~ (c -> Text)) => LabelOptic "help" k (Command m c a2) (Command m c a2) a1 b Source #
Instance details Defined in CalamityCommands.Command Methods labelOptic :: Optic k NoIx (Command m c a2) (Command m c a2) a1 b #
(k ~ A_Lens, a1 ~ Bool, b ~ Bool) => LabelOptic "hidden" k (Command m c a2) (Command m c a2) a1 b Source #
Instance details Defined in CalamityCommands.Command Methods labelOptic :: Optic k NoIx (Command m c a2) (Command m c a2) a1 b #
(k ~ A_Lens, a1 ~ NonEmpty Text, b ~ NonEmpty Text) => LabelOptic "names" k (Command m c a2) (Command m c a2) a1 b Source #
Instance details Defined in CalamityCommands.Command Methods labelOptic :: Optic k NoIx (Command m c a2) (Command m c a2) a1 b #
(k ~ A_Lens, a1 ~ [ParameterInfo], b ~ [ParameterInfo]) => LabelOptic "params" k (Command m c a2) (Command m c a2) a1 b Source #
Instance details Defined in CalamityCommands.Command Methods labelOptic :: Optic k NoIx (Command m c a2) (Command m c a2) a1 b #
(k ~ A_Lens, a1 ~ Maybe (Group m c a2), b ~ Maybe (Group m c a2)) => LabelOptic "parent" k (Command m c a2) (Command m c a2) a1 b Source #
Instance details Defined in CalamityCommands.Command Methods labelOptic :: Optic k NoIx (Command m c a2) (Command m c a2) a1 b #
Show (Command m c a) Source #
Instance details Defined in CalamityCommands.Command Methods showsPrec :: Int -> Command m c a -> ShowS # show :: Command m c a -> String # showList :: [Command m c a] -> ShowS #
TextShow (Command m c a) Source #
Instance details Defined in CalamityCommands.Command Methods showbPrec :: Int -> Command m c a -> Builder # showb :: Command m c a -> Builder # showbList :: [Command m c a] -> Builder # showtPrec :: Int -> Command m c a -> Text # showt :: Command m c a -> Text # showtList :: [Command m c a] -> Text # showtlPrec :: Int -> Command m c a -> Text # showtl :: Command m c a -> Text # showtlList :: [Command m c a] -> Text #