Client.Commands.Arguments

This module provides a description for the arguments expected by command commands as well as a way to parse those arguments.

Documentation

data ArgumentSpec :: * -> * where

Description of a command's arguments indexed by the result of parsing those arguments. Arguments are annotated with a String describing the argument.

Constructors

ReqTokenArg :: String -> ArgumentSpec rest -> ArgumentSpec (String, rest)

A required space-delimited token

OptTokenArg :: String -> ArgumentSpec rest -> ArgumentSpec (Maybe (String, rest))

An optional space-delimited token

RemainingArg :: String -> ArgumentSpec String

Take all the remaining text in free-form

NoArg :: ArgumentSpec ()

No arguments

Instances

Show (ArgumentSpec s)

Methods

showsPrec :: Int -> ArgumentSpec s -> ShowS

show :: ArgumentSpec s -> String

showList :: [ArgumentSpec s] -> ShowS

parseArguments

Arguments

:: ArgumentSpec a

specification

-> String

input string

-> Maybe a

parse results

Parse the given input string using an argument specification. The arguments should start with a space but might have more.