CalamityCommands.Context

Command context typeclass

Documentation

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

Methods

ctxPrefix :: c -> Text

The prefix that was used to invoke the command

ctxCommand :: c -> Command m c a

The command that was invoked

ctxUnparsedParams :: c -> Text

The message remaining after consuming the prefix

Instances

CommandContext m (BasicContext m a) a

Defined in CalamityCommands.Context

Methods

ctxPrefix :: BasicContext m a -> Text

ctxCommand :: BasicContext m a -> Command m (BasicContext m a) a

ctxUnparsedParams :: BasicContext m a -> Text

data ConstructContext msg ctx m' a' m a where

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)

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

Construct a context for a command invokation, returning Just context on success, or Nothing if a context could not be constructed

data BasicContext m a

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

(k ~ A_Lens, a1 ~ Command m1 (BasicContext m1 a2) a2, b ~ Command m2 (BasicContext m2 a3) a3) => LabelOptic "bcCommand" k (BasicContext m1 a2) (BasicContext m2 a3) a1 b

Defined in CalamityCommands.Context

Methods

labelOptic :: Optic k NoIx (BasicContext m1 a2) (BasicContext m2 a3) a1 b

(k ~ A_Lens, a1 ~ Text, b ~ Text) => LabelOptic "bcPrefix" k (BasicContext m a2) (BasicContext m a2) a1 b

Defined in CalamityCommands.Context

Methods

labelOptic :: Optic k NoIx (BasicContext m a2) (BasicContext m a2) a1 b

(k ~ A_Lens, a1 ~ Text, b ~ Text) => LabelOptic "bcUnparsedParams" k (BasicContext m a2) (BasicContext m a2) a1 b

Defined in CalamityCommands.Context

Methods

labelOptic :: Optic k NoIx (BasicContext m a2) (BasicContext m a2) a1 b

CommandContext m (BasicContext m a) a

Defined in CalamityCommands.Context

Methods

ctxPrefix :: BasicContext m a -> Text

ctxCommand :: BasicContext m a -> Command m (BasicContext m a) a

ctxUnparsedParams :: BasicContext m a -> Text

Show (BasicContext m a)

Defined in CalamityCommands.Context

Methods

showsPrec :: Int -> BasicContext m a -> ShowS

show :: BasicContext m a -> String

showList :: [BasicContext m a] -> ShowS

useBasicContext :: Sem (ConstructContext msg (BasicContext m a') m a' ': r) a -> Sem r a

A default interpretation for ConstructContext that constructs a BasicContext