Calamity.Commands.Parser

Something that can parse user input

Documentation

class Typeable a => Parser (a :: Type) r where

Minimal complete definition

parse

Associated Types

type ParserResult a

type ParserResult a = a

Methods

parserName :: Text

default parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult a)

Instances

Parser () r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult ()

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult ())

Parser Text r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Text

Methods

parserName :: Text0

parse :: Sem (ParserEffs r) (ParserResult Text)

Parser Text r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Text

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult Text)

Parser Member r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Member

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult Member)

Member (CacheEff :: (Type -> Type) -> Type -> Type) r => Parser User r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult User

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult User)

Parser a r => Parser [a] r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult [a]

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult [a])

Parser a r => Parser (Maybe a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Maybe a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Maybe a))

(Parser a r, Typeable a) => Parser (NonEmpty a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (NonEmpty a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (NonEmpty a))

Typeable (Snowflake a) => Parser (Snowflake a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Snowflake a))

Parser (Snowflake Channel) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake Channel)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Snowflake Channel))

Parser (Snowflake Member) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake Member)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Snowflake Member))

Parser (Snowflake User) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake User)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Snowflake User))

Parser (Snowflake Role) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake Role)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Snowflake Role))

Parser (Snowflake Emoji) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake Emoji)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Snowflake Emoji))

(Monoid (ParserResult a), Parser a r) => Parser (KleeneConcat a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneConcat a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (KleeneConcat a))

Parser (KleeneConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneConcat Text)

Methods

parserName :: Text0

parse :: Sem (ParserEffs r) (ParserResult (KleeneConcat Text))

Parser (KleeneConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneConcat Text)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (KleeneConcat Text))

(Parser a r, Parser b r) => Parser (a, b) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (a, b)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (a, b))

(KnownSymbol s, Parser a r) => Parser (Named s a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Named s a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Named s a))

data Named (s :: Symbol) (a :: Type)

A named parameter, used to attach the name s to a type in the command's help output

Instances

(KnownSymbol s, Parser a r) => Parser (Named s a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Named s a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (Named s a))

type ParserResult (Named s a)

Defined in Calamity.Commands.Parser

type ParserResult (Named s a) = ParserResult a

data KleeneConcat (a :: Type)

A parser that consumes zero or more of a then concatenates them together.

KleeneConcat Text Is therefore consumes all remaining input.

Instances

(Monoid (ParserResult a), Parser a r) => Parser (KleeneConcat a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneConcat a)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (KleeneConcat a))

Parser (KleeneConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneConcat Text)

Methods

parserName :: Text0

parse :: Sem (ParserEffs r) (ParserResult (KleeneConcat Text))

Parser (KleeneConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneConcat Text)

Methods

parserName :: Text

parse :: Sem (ParserEffs r) (ParserResult (KleeneConcat Text))

type ParserResult (KleeneConcat a)

Defined in Calamity.Commands.Parser

type ParserResult (KleeneConcat a) = ParserResult a

type ParserResult (KleeneConcat Text)

Defined in Calamity.Commands.Parser

type ParserResult (KleeneConcat Text) = ParserResult Text

type ParserResult (KleeneConcat Text)

Defined in Calamity.Commands.Parser

type ParserResult (KleeneConcat Text) = ParserResult Text

runCommandParser :: Context -> Text -> Sem (ParserEffs r) a -> Sem r (Either (Text, Text) a)