Safe Haskell	None
Language	Haskell2010

CalamityCommands.Context

Description

Command context typeclass

Synopsis

class CommandContext m c a | c -> m, c -> a where
- ctxPrefix :: c -> Text
- ctxCommand :: c -> Command m c a
- ctxUnparsedParams :: c -> Text
data ConstructContext msg ctx m' a' m a where
- ConstructContext :: (Text, Command m' ctx a', Text) -> msg -> ConstructContext msg ctx m' a' m (Maybe ctx)
constructContext :: forall msg ctx m' a' r. MemberWithError (ConstructContext msg ctx m' a') r => (Text, Command m' ctx a', Text) -> msg -> Sem r (Maybe ctx)
data BasicContext m a = BasicContext {
- bcPrefix :: Text
- bcCommand :: Command m (BasicContext m a) a
- bcUnparsedParams :: Text
}
useBasicContext :: Sem (ConstructContext msg (BasicContext m a') m a' ': r) a -> Sem r a

Documentation

class CommandContext m c a | c -> m, c -> a where Source #

Methods

The prefix that was used to invoke the command

The command that was invoked

The message remaining after consuming the prefix

Instances details

CommandContext m (BasicContext m a) a Source #
Instance details Defined in CalamityCommands.Context Methods ctxPrefix :: BasicContext m a -> Text Source # ctxCommand :: BasicContext m a -> Command m (BasicContext m a) a Source # ctxUnparsedParams :: BasicContext m a -> Text Source #

data ConstructContext msg ctx m' a' m a where Source #

An effect for constructing the context for a command

Constructors

ConstructContext	Construct a context for a command invokation, returning Just `context` on success, or Nothing if a context could not be constructed
Fields :: (Text, Command m' ctx a', Text) The (prefix, command, remaining) -> msg The message type to extract the context from -> ConstructContext msg ctx m' a' m (Maybe ctx)

Instances details

type DefiningModule (ConstructContext :: Type -> Type -> (Type -> Type) -> Type -> k -> Type -> Type) Source #
Instance details Defined in CalamityCommands.Context type DefiningModule (ConstructContext :: Type -> Type -> (Type -> Type) -> Type -> k -> Type -> Type) = "CalamityCommands.Context"

constructContext :: forall msg ctx m' a' r. MemberWithError (ConstructContext msg ctx m' a') r => (Text, Command m' ctx a', Text) -> msg -> Sem r (Maybe ctx) Source #

A basic context that only knows the prefix used and the unparsed input

Constructors

BasicContext
Fields bcPrefix :: Text bcCommand :: Command m (BasicContext m a) a bcUnparsedParams :: Text

Instances details

CommandContext m (BasicContext m a) a Source #
Instance details Defined in CalamityCommands.Context Methods ctxPrefix :: BasicContext m a -> Text Source # ctxCommand :: BasicContext m a -> Command m (BasicContext m a) a Source # ctxUnparsedParams :: BasicContext m a -> Text Source #
Show (BasicContext m a) Source #
Instance details Defined in CalamityCommands.Context Methods showsPrec :: Int -> BasicContext m a -> ShowS # show :: BasicContext m a -> String # showList :: [BasicContext m a] -> ShowS #
Generic (BasicContext m a) Source #
Instance details Defined in CalamityCommands.Context Associated Types type Rep (BasicContext m a) :: Type -> Type # Methods from :: BasicContext m a -> Rep (BasicContext m a) x # to :: Rep (BasicContext m a) x -> BasicContext m a #
type Rep (BasicContext m a) Source #
Instance details Defined in CalamityCommands.Context type Rep (BasicContext m a) = D1 ('MetaData "BasicContext" "CalamityCommands.Context" "calamity-commands-0.1.3.0-inplace" 'False) (C1 ('MetaCons "BasicContext" 'PrefixI 'True) (S1 ('MetaSel ('Just "bcPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "bcCommand") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Command m (BasicContext m a) a)) :: S1 ('MetaSel ('Just "bcUnparsedParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

A default interpretation for ConstructContext that constructs a BasicContext