Ribosome.Host.Data.CommandMods

Special command parameter that exposes the used modifiers.

Documentation

newtype CommandMods

When this type is used as a parameter of a command handler function, the RPC trigger uses the special token q-mods in the call.

This type then contains the list of pre-command modifiers specified by the user, like :belowright.

Constructors

CommandMods

Fields

• unCommandMods :: Text

Instances

Show CommandMods

Defined in Ribosome.Host.Data.CommandMods

Methods

showsPrec :: Int -> CommandMods -> ShowS

show :: CommandMods -> String

showList :: [CommandMods] -> ShowS

Eq CommandMods

Defined in Ribosome.Host.Data.CommandMods

Methods

(==) :: CommandMods -> CommandMods -> Bool

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

MsgpackDecode CommandMods

Defined in Ribosome.Host.Data.CommandMods

Methods

fromMsgpack :: Object -> Either DecodeError CommandMods

BeforeRegular al CommandMods => SpecialParam ('OptionState al c ac) CommandMods

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al c ac) CommandMods :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type TransSpecial ('OptionState al c ac) CommandMods

Defined in Ribosome.Host.Handler.Command

type TransSpecial ('OptionState al c ac) CommandMods = 'OptionState al c ac