Ribosome.Host.Data.CommandRegister

Special command parameter that exposes the used register.

Documentation

newtype CommandRegister

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

This type then contains the name of the register specified by the user.

Constructors

CommandRegister

Fields

• unCommandRegister :: Text

Instances

IsString CommandRegister

Defined in Ribosome.Host.Data.CommandRegister

Methods

fromString :: String -> CommandRegister

Show CommandRegister

Defined in Ribosome.Host.Data.CommandRegister

Methods

showsPrec :: Int -> CommandRegister -> ShowS

show :: CommandRegister -> String

showList :: [CommandRegister] -> ShowS

Eq CommandRegister

Defined in Ribosome.Host.Data.CommandRegister

Methods

(==) :: CommandRegister -> CommandRegister -> Bool

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

Ord CommandRegister

Defined in Ribosome.Host.Data.CommandRegister

Methods

compare :: CommandRegister -> CommandRegister -> Ordering

(<) :: CommandRegister -> CommandRegister -> Bool

(<=) :: CommandRegister -> CommandRegister -> Bool

(>) :: CommandRegister -> CommandRegister -> Bool

(>=) :: CommandRegister -> CommandRegister -> Bool

max :: CommandRegister -> CommandRegister -> CommandRegister

min :: CommandRegister -> CommandRegister -> CommandRegister

MsgpackDecode CommandRegister

Defined in Ribosome.Host.Data.CommandRegister

Methods

fromMsgpack :: Object -> Either DecodeError CommandRegister

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

Defined in Ribosome.Host.Handler.Command

Associated Types

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

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type TransSpecial ('OptionState al c ac) CommandRegister

Defined in Ribosome.Host.Handler.Command

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