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 Float r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Float

Methods

parserName :: Text

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

Parser Int r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Int

Methods

parserName :: Text

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

Parser Integer r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Integer

Methods

parserName :: Text

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

Parser Natural r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Natural

Methods

parserName :: Text

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

Parser Word r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Word

Methods

parserName :: Text

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

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 :: Text

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

Parser Text r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Text

Methods

parserName :: Text0

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

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

Parser for guilds, this only looks in the cache. Use Snowflake Guild and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Guild

Methods

parserName :: Text

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

Parser Member r

Parser for members in the guild the command was invoked in, this only looks in the cache. Use Snowflake Member and use upgrade if you want to allow fetching from http.

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

Parser for users, this only looks in the cache. Use Snowflake User and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult User

Methods

parserName :: Text

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

Parser Role r

Parser for roles in the guild the command was invoked in, this only looks in the cache. Use Snowflake Role and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Role

Methods

parserName :: Text

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

Parser RawEmoji r

Parses both discord emojis, and unicode emojis

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult RawEmoji

Methods

parserName :: Text

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

Parser Emoji r

Parser for emojis in the guild the command was invoked in, this only looks in the cache. Use Snowflake Emoji and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult Emoji

Methods

parserName :: Text

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

Parser GuildChannel r

Parser for channels in the guild the command was invoked in, this only looks in the cache. Use Snowflake Channel and use upgrade if you want to allow fetching from http.

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult GuildChannel

Methods

parserName :: Text

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

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

Accepts both plain IDs and mentions

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

Accepts both plain IDs and mentions

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

Accepts both plain IDs and mentions

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

Accepts both plain IDs and mentions

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

Accepts both plain IDs and uses of emoji

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Snowflake Emoji)

Methods

parserName :: Text

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

(Semigroup (ParserResult a), Parser a r) => Parser (KleenePlusConcat a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleenePlusConcat a)

Methods

parserName :: Text

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

Parser (KleenePlusConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parserName :: Text

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

Parser (KleenePlusConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parserName :: Text0

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

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

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneStarConcat a)

Methods

parserName :: Text

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

Parser (KleeneStarConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parserName :: Text

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

Parser (KleeneStarConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parserName :: Text0

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

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

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (Either a b)

Methods

parserName :: Text

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

(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 KleeneStarConcat (a :: Type)

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

KleeneStarConcat Text therefore consumes all remaining input.

Instances

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

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneStarConcat a)

Methods

parserName :: Text

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

Parser (KleeneStarConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parserName :: Text

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

Parser (KleeneStarConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parserName :: Text0

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

type ParserResult (KleeneStarConcat a)

Defined in Calamity.Commands.Parser

type ParserResult (KleeneStarConcat a) = ParserResult a

type ParserResult (KleeneStarConcat Text)

Defined in Calamity.Commands.Parser

type ParserResult (KleeneStarConcat Text) = ParserResult Text

type ParserResult (KleeneStarConcat Text)

Defined in Calamity.Commands.Parser

type ParserResult (KleeneStarConcat Text) = ParserResult Text

data KleenePlusConcat (a :: Type)

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

KleenePlusConcat Text therefore consumes all remaining input.

Instances

(Semigroup (ParserResult a), Parser a r) => Parser (KleenePlusConcat a) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleenePlusConcat a)

Methods

parserName :: Text

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

Parser (KleenePlusConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parserName :: Text

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

Parser (KleenePlusConcat Text) r

Defined in Calamity.Commands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parserName :: Text0

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

type ParserResult (KleenePlusConcat a)

Defined in Calamity.Commands.Parser

type ParserResult (KleenePlusConcat a) = ParserResult a

type ParserResult (KleenePlusConcat Text)

Defined in Calamity.Commands.Parser

type ParserResult (KleenePlusConcat Text) = ParserResult Text

type ParserResult (KleenePlusConcat Text)

Defined in Calamity.Commands.Parser

type ParserResult (KleenePlusConcat Text) = ParserResult Text

type ParserEffs r = State ParserState ': (Error (Text, Text) ': (Reader Context ': r))

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