Safe Haskell	Safe
Language	Haskell2010

System.REPL.Types

Description

Types used by other modules in the package.

The module contains the following exception hierarchy:

Synopsis

Documentation

type TypeError = SomeException Source

An error message indicating that a value wasn't able to be parsed.

type PredicateError = SomeException Source

An error message indicating that a value failied a predicate.

type PromptMsg = Text Source

A prompt.

type Predicate m a b = a -> m (Either PredicateError b) Source

A predicate which a value has to fulfil.

type Predicate' m a = Predicate m a a Source

A predicate which does not change the type of its input.

type Parser a = Text -> Either TypeError a Source

A parser which either returns a parsed value or an error message.

data Asker m a b Source

The description of an 'ask for user input'-action. The type parameters are the used monad (typically IO or ExceptT), the type of the read value and the type of the error that is thrown in case of failures.

The components are a prompt, a parser, and a predicate that the parsed value must fulfil. The the predicate

is monadic and
can change the returned type (useful for adjoining additional information)

Constructors

Asker
Fields askerPrompt :: Text The prompt to be displayed to the user. askerParser :: Parser a The parser for the input value. askerPredicate :: Predicate m a b The predicate which the input, once read, must fulfill. The Left side is an error message.

type Asker' m a = Asker m a a Source

An Asker which does not convert its argument into different type after parsing.

data SomeREPLError Source

Root of the exception hierarchy.

Constructors

forall e . Exception e => SomeREPLError e

Instances

Show SomeREPLError Source
Exception SomeREPLError Source

replErrorUpcast :: Exception a => a -> SomeException Source

replErrorDowncast :: Exception a => SomeException -> Maybe a Source

data SomeAskerError Source

Generic error related to Askers. Either the input was incorrect in some way, or the process was aborted by the user.

Constructors

forall e . Exception e => SomeAskerError e

Instances

Show SomeAskerError Source
Exception SomeAskerError Source

askerErrorUpcast :: Exception a => a -> SomeException Source

askerErrorDowncast :: Exception a => SomeException -> Maybe a Source

data AskerTypeError Source

The input wasn't able to be parsed.

Constructors

AskerTypeError SomeException

Instances

Show AskerTypeError Source
Exception AskerTypeError Source

data AskerPredicateError Source

The parsed value failed a predicate.

Constructors

AskerPredicateError SomeException

Instances

Show AskerPredicateError Source
Exception AskerPredicateError Source

data AskerInputAbortedError Source

The input for an Asker was aborted by the user.

Constructors

AskerInputAbortedError

Instances

Show AskerInputAbortedError Source
Exception AskerInputAbortedError Source

data GenericTypeError Source

A generic type failure for use with Askers.

Constructors

GenericTypeError Text

Instances

Eq GenericTypeError Source
Show GenericTypeError Source
Exception GenericTypeError Source

genericTypeError :: Text -> SomeException Source

Constructor for GenericTypeError which wraps the value into a SomeException.

data GenericPredicateError Source

A generic predicate failure for use with Askers.

Constructors

GenericPredicateError Text

Instances

Eq GenericPredicateError Source
Show GenericPredicateError Source
Exception GenericPredicateError Source

genericPredicateError :: Text -> SomeException Source

Constructor for GenericTypeError which wraps the value into a SomeException.

newtype Verbatim Source

A verbatim Text whose Read instance simply returns the read string, as-is. This is useful for askers which ask for strings without quotes.

Constructors

Verbatim
Fields fromVerbatim :: Text

Instances

Read Verbatim Source

Read-instance for Verbatim. Wraps the given value into quotes and reads it a a Text.

data PathExistenceType Source

Indicates whether the target of a path exists and what form it has.

Constructors

IsDirectory
IsFile
DoesNotExist

Instances

Bounded PathExistenceType Source
Enum PathExistenceType Source
Eq PathExistenceType Source
Ord PathExistenceType Source
Read PathExistenceType Source
Show PathExistenceType Source

data PathRootDoesNotExist Source

Indicates that no part of a path exists.

Constructors

PathRootDoesNotExist FilePath

Instances

Eq PathRootDoesNotExist Source
Show PathRootDoesNotExist Source
Exception PathRootDoesNotExist Source

data PathIsNotWritable Source

Indicatres that the last existing portion of a path is not writable.

Constructors

PathIsNotWritable FilePath

Instances

Eq PathIsNotWritable Source
Show PathIsNotWritable Source
Exception PathIsNotWritable Source

data SomeCommandError Source

Generic error related to command execution.

Constructors

forall e . Exception e => SomeCommandError e

Instances

Show SomeCommandError Source
Exception SomeCommandError Source

commandErrorUpcast :: Exception a => a -> SomeException Source

commandErrorDowncast :: Exception a => SomeException -> Maybe a Source

data MalformedParamsError Source

The input of a command was malformed and could not interpreted. I.e. the input contained inadmissible characters, or quotes were mismatched. The Text argument contains the parser error.

Constructors

MalformedParamsError Text

Instances

Eq MalformedParamsError Source
Ord MalformedParamsError Source
Show MalformedParamsError Source
Exception MalformedParamsError Source

data TooManyParamsError Source

Too many parameters were given to a command. The first value is the maximum, the second the actual number.

Constructors

TooManyParamsError Int Int

Instances

Eq TooManyParamsError Source
Ord TooManyParamsError Source
Show TooManyParamsError Source
Exception TooManyParamsError Source

data TooFewParamsError Source

Too few parameters were given to a command. The first value is the minium, the second the actual number.

Constructors

TooFewParamsError Int Int

Instances

Eq TooFewParamsError Source
Ord TooFewParamsError Source
Show TooFewParamsError Source
Exception TooFewParamsError Source

data Command m i a Source

A REPL command, possibly with parameters.

Constructors

Command

Fields

commandName :: Text: The short name of the command. Purely informative.
commandTest :: i -> Bool: Returns whether the first part of an input (the command name) matches a the command. defCommandTest is appropriate for most cases.
commandDesc :: Text: A description of the command.
runPartialCommand :: [i] -> m (a, [i]): Runs the command with the input text as parameter, returning the unconsumed input.

Instances

Functor m => Functor (Command m i) Source
Monad m => Apply (Command m i) Source
Monad m => Bind (Command m i) Source

data NoConfigFileParseError Source

Indicates that some string was not able to be parsed.

Constructors

NoConfigFileParseError Text

Instances

Eq NoConfigFileParseError Source
Read NoConfigFileParseError Source
Show NoConfigFileParseError Source
Exception NoConfigFileParseError Source