Ribosome.Host.Data.Args

Special command parameters governing the aggregation of the entire (rest of the) argument list into one value.

Documentation

newtype Args

When this type is used as the (last) parameter of a command handler function, all remaining tokens passed to the command will be consumed and stored in this type.

The command will be declared with the -nargs=* or -nargs=+ option.

See CommandHandler.

Constructors

Args

Fields

• unArgs :: Text

Instances

IsString Args

Defined in Ribosome.Host.Data.Args

Methods

fromString :: String -> Args

Show Args

Defined in Ribosome.Host.Data.Args

Methods

showsPrec :: Int -> Args -> ShowS

show :: Args -> String

showList :: [Args] -> ShowS

Eq Args

Defined in Ribosome.Host.Data.Args

Methods

(==) :: Args -> Args -> Bool

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

Ord Args

Defined in Ribosome.Host.Data.Args

Methods

compare :: Args -> Args -> Ordering

(<) :: Args -> Args -> Bool

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

(>) :: Args -> Args -> Bool

(>=) :: Args -> Args -> Bool

max :: Args -> Args -> Args

min :: Args -> Args -> Args

Member (Stop Report) r => HandlerArg Args r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Args)

SpecialParam ('OptionState al count ('Nothing :: Maybe Type)) Args

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count 'Nothing) Args :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type TransSpecial ('OptionState al count ('Nothing :: Maybe Type)) Args

Defined in Ribosome.Host.Handler.Command

type TransSpecial ('OptionState al count ('Nothing :: Maybe Type)) Args = 'OptionState 'True (Max count 'MinZero) ('Just Args)

newtype ArgList

When this type is used as the (last) parameter of a command handler function, all remaining tokens passed to the command will be consumed and stored in this type, as a list of whitespace separated tokens.

The command will be declared with the -nargs=* or -nargs=+ option.

See CommandHandler.

Constructors

ArgList

Fields

• unArgList :: [Text]

Instances

Show ArgList

Defined in Ribosome.Host.Data.Args

Methods

showsPrec :: Int -> ArgList -> ShowS

show :: ArgList -> String

showList :: [ArgList] -> ShowS

Eq ArgList

Defined in Ribosome.Host.Data.Args

Methods

(==) :: ArgList -> ArgList -> Bool

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

Member (Stop Report) r => HandlerArg ArgList r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], ArgList)

SpecialParam ('OptionState al count ac) ArgList

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count ac) ArgList :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type TransSpecial ('OptionState al count ac) ArgList

Defined in Ribosome.Host.Handler.Command

type TransSpecial ('OptionState al count ac) ArgList = 'OptionState 'True (Max count 'MinZero) ('Just ArgList)

newtype JsonArgs a

When this type is used as the (last) parameter of a command handler function, all remaining tokens passed to the command will be consumed, decoded as JSON and stored in this type.

The command will be declared with the -nargs=* or -nargs=+ option.

See CommandHandler.

Constructors

JsonArgs

Fields

• unJsonArgs :: a

Instances

Show a => Show (JsonArgs a)

Defined in Ribosome.Host.Data.Args

Methods

showsPrec :: Int -> JsonArgs a -> ShowS

show :: JsonArgs a -> String

showList :: [JsonArgs a] -> ShowS

Eq a => Eq (JsonArgs a)

Defined in Ribosome.Host.Data.Args

Methods

(==) :: JsonArgs a -> JsonArgs a -> Bool

(/=) :: JsonArgs a -> JsonArgs a -> Bool

(Member (Stop Report) r, FromJSON a) => HandlerArg (JsonArgs a) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], JsonArgs a)

SpecialParam ('OptionState al count ac) (JsonArgs a)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count ac) (JsonArgs a) :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type TransSpecial ('OptionState al count ac) (JsonArgs a)

Defined in Ribosome.Host.Handler.Command

type TransSpecial ('OptionState al count ac) (JsonArgs a) = 'OptionState 'True (Max count 'MinZero) ('Just (JsonArgs a))

newtype Options a

When this type is used as the (last) parameter of a command handler function, all remaining tokens passed to the command will be consumed, parsed via optparse-applicative and stored in this type.

The parser associated with a must be defined as an instance of OptionParser a.

The command will be declared with the -nargs=* or -nargs=+ option.

See CommandHandler.

Constructors

Options a

Instances

Show a => Show (Options a)

Defined in Ribosome.Host.Data.Args

Methods

showsPrec :: Int -> Options a -> ShowS

show :: Options a -> String

showList :: [Options a] -> ShowS

Eq a => Eq (Options a)

Defined in Ribosome.Host.Data.Args

Methods

(==) :: Options a -> Options a -> Bool

(/=) :: Options a -> Options a -> Bool

(Member (Stop Report) r, OptionParser a) => HandlerArg (Options a) r

Defined in Ribosome.Host.Handler.Codec

Methods

handlerArg :: [Object] -> Sem r ([Object], Options a)

SpecialParam ('OptionState al count ('Nothing :: Maybe Type)) (Options a)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count 'Nothing) (Options a) :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type TransSpecial ('OptionState al count ('Nothing :: Maybe Type)) (Options a)

Defined in Ribosome.Host.Handler.Command

type TransSpecial ('OptionState al count ('Nothing :: Maybe Type)) (Options a) = 'OptionState 'True (Max count 'MinZero) ('Just (Options a))

class OptionParser a where

The parser used when declaring command handlers with the special parameter Options a.

Methods

optionParser :: Parser a