Calamity.Types.Snowflake

The snowflake type

Documentation

newtype Snowflake (t :: Type)

Constructors

Snowflake

Fields

• fromSnowflake :: Word64

Instances

HasID a (Snowflake a)

Defined in Calamity.Types.Snowflake

Methods

getID :: Snowflake a -> Snowflake a

Upgradeable Channel (Snowflake Channel)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake Channel -> Sem r (Maybe Channel)

Upgradeable DMChannel (Snowflake DMChannel)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake DMChannel -> Sem r (Maybe DMChannel)

Upgradeable GroupChannel (Snowflake GroupChannel)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake GroupChannel -> Sem r (Maybe GroupChannel)

Upgradeable GuildChannel (Snowflake GuildChannel)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake GuildChannel -> Sem r (Maybe GuildChannel)

Upgradeable Category (Snowflake Category)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake Category -> Sem r (Maybe Category)

Upgradeable TextChannel (Snowflake TextChannel)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake TextChannel -> Sem r (Maybe TextChannel)

Upgradeable VoiceChannel (Snowflake VoiceChannel)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake VoiceChannel -> Sem r (Maybe VoiceChannel)

Upgradeable Guild (Snowflake Guild)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake Guild -> Sem r (Maybe Guild)

Upgradeable User (Snowflake User)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => Snowflake User -> Sem r (Maybe User)

Upgradeable Emoji (Snowflake Guild, Snowflake Emoji)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => (Snowflake Guild, Snowflake Emoji) -> Sem r (Maybe Emoji)

Upgradeable Member (Snowflake Guild, Snowflake Member)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => (Snowflake Guild, Snowflake Member) -> Sem r (Maybe Member)

Upgradeable Role (Snowflake Guild, Snowflake Role)

Defined in Calamity.Types.Upgradeable

Methods

upgrade :: forall (r :: EffectRow). BotC r => (Snowflake Guild, Snowflake Role) -> Sem r (Maybe Role)

FromJSON (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

parseJSON :: Value -> Parser (Snowflake t)

parseJSONList :: Value -> Parser [Snowflake t]

FromJSONKey (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

fromJSONKey :: FromJSONKeyFunction (Snowflake t)

fromJSONKeyList :: FromJSONKeyFunction [Snowflake t]

ToJSON (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

toJSON :: Snowflake t -> Value

toEncoding :: Snowflake t -> Encoding

toJSONList :: [Snowflake t] -> Value

toEncodingList :: [Snowflake t] -> Encoding

ToJSONKey (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

toJSONKey :: ToJSONKeyFunction (Snowflake t)

toJSONKeyList :: ToJSONKeyFunction [Snowflake t]

Data t => Data (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Snowflake t -> c (Snowflake t)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Snowflake t)

toConstr :: Snowflake t -> Constr

dataTypeOf :: Snowflake t -> DataType

dataCast1 :: Typeable t0 => (forall d. Data d => c (t0 d)) -> Maybe (c (Snowflake t))

dataCast2 :: Typeable t0 => (forall d e. (Data d, Data e) => c (t0 d e)) -> Maybe (c (Snowflake t))

gmapT :: (forall b. Data b => b -> b) -> Snowflake t -> Snowflake t

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Snowflake t -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Snowflake t -> r

gmapQ :: (forall d. Data d => d -> u) -> Snowflake t -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Snowflake t -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Snowflake t -> m (Snowflake t)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Snowflake t -> m (Snowflake t)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Snowflake t -> m (Snowflake t)

Show (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

showsPrec :: Int -> Snowflake t -> ShowS

show :: Snowflake t -> String

showList :: [Snowflake t] -> ShowS

Tellable (Snowflake Channel)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake Channel -> Sem r (Snowflake Channel)

Tellable (Snowflake DMChannel)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake DMChannel -> Sem r (Snowflake Channel)

Tellable (Snowflake TextChannel)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake TextChannel -> Sem r (Snowflake Channel)

Tellable (Snowflake Member)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member0 (Error RestError) r) => Snowflake Member -> Sem r (Snowflake Channel)

Tellable (Snowflake User)

Defined in Calamity.Types.Tellable

Methods

getChannel :: forall (r :: EffectRow). (BotC r, Member (Error RestError) r) => Snowflake User -> Sem r (Snowflake Channel)

Mentionable (Snowflake Channel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Channel -> Text

Mentionable (Snowflake DMChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake DMChannel -> Text

Mentionable (Snowflake GuildChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake GuildChannel -> Text

Mentionable (Snowflake Category)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Category -> Text

Mentionable (Snowflake TextChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake TextChannel -> Text

Mentionable (Snowflake VoiceChannel)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake VoiceChannel -> Text

Mentionable (Snowflake Member)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Member -> Text

Mentionable (Snowflake Role)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake Role -> Text

Mentionable (Snowflake User)

Defined in Calamity.Utils.Message

Methods

mention :: Snowflake User -> Text

PermissionsIn' (Snowflake GuildChannel)

A Member's Permissions in a channel are their roles and overwrites

This will fetch the guild and channel from the cache or http as needed

Defined in Calamity.Utils.Permissions

Methods

permissionsIn' :: forall (r :: EffectRow) u. (BotC r, HasID User u) => Snowflake GuildChannel -> u -> Sem r Permissions

PermissionsIn' (Snowflake Guild)

A Member's Permissions in a guild are just their roles

This will fetch the guild from the cache or http as needed

Defined in Calamity.Utils.Permissions

Methods

permissionsIn' :: forall (r :: EffectRow) u. (BotC r, HasID User u) => Snowflake Guild -> u -> Sem r Permissions

Eq (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

(==) :: Snowflake t -> Snowflake t -> Bool

(/=) :: Snowflake t -> Snowflake t -> Bool

Ord (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

compare :: Snowflake t -> Snowflake t -> Ordering

(<) :: Snowflake t -> Snowflake t -> Bool

(<=) :: Snowflake t -> Snowflake t -> Bool

(>) :: Snowflake t -> Snowflake t -> Bool

(>=) :: Snowflake t -> Snowflake t -> Bool

max :: Snowflake t -> Snowflake t -> Snowflake t

min :: Snowflake t -> Snowflake t -> Snowflake t

Hashable (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

hashWithSalt :: Int -> Snowflake t -> Int

hash :: Snowflake t -> Int

ToHttpApiData (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

toUrlPiece :: Snowflake t -> Text

toEncodedUrlPiece :: Snowflake t -> Builder

toHeader :: Snowflake t -> ByteString

toQueryParam :: Snowflake t -> Text

TextShow (Snowflake t)

Defined in Calamity.Types.Snowflake

Methods

showbPrec :: Int -> Snowflake t -> Builder

showb :: Snowflake t -> Builder

showbList :: [Snowflake t] -> Builder

showtPrec :: Int -> Snowflake t -> Text

showt :: Snowflake t -> Text

showtList :: [Snowflake t] -> Text

showtlPrec :: Int -> Snowflake t -> Text

showtl :: Snowflake t -> Text

showtlList :: [Snowflake t] -> Text

Unboxable (Snowflake t)

Defined in Calamity.Types.Snowflake

Associated Types

type Rep (Snowflake t)

type CoercibleRep (Snowflake t)

type IsTrivial (Snowflake t) :: Bool

Methods

unboxingFrom :: Snowflake t -> Rep (Snowflake t)

unboxingTo :: Rep (Snowflake t) -> Snowflake t

ParameterParser (Snowflake Channel) c r

Accepts both plain IDs and mentions

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake Channel)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

ParameterParser (Snowflake Emoji) c r

Accepts both plain IDs and uses of emoji

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake Emoji)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

ParameterParser (Snowflake Member) c r

Accepts both plain IDs and mentions

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake Member)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

ParameterParser (Snowflake Role) c r

Accepts both plain IDs and mentions

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake Role)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

ParameterParser (Snowflake User) c r

Accepts both plain IDs and mentions

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake User)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

Typeable (Snowflake a) => ParameterParser (Snowflake a) c r

Defined in Calamity.Commands.CalamityParsers

Associated Types

type ParserResult (Snowflake a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

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

type ParserResult (Snowflake Channel)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake Channel) = Snowflake Channel

type ParserResult (Snowflake Emoji)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake Emoji) = Snowflake Emoji

type ParserResult (Snowflake Member)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake Member) = Snowflake Member

type ParserResult (Snowflake Role)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake Role) = Snowflake Role

type ParserResult (Snowflake User)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake User) = Snowflake User

type ParserResult (Snowflake a)

Defined in Calamity.Commands.CalamityParsers

type ParserResult (Snowflake a) = Snowflake a

type CoercibleRep (Snowflake t)

Defined in Calamity.Types.Snowflake

type CoercibleRep (Snowflake t) = CoercibleRep Word64

type IsTrivial (Snowflake t)

Defined in Calamity.Types.Snowflake

type IsTrivial (Snowflake t) = IsTrivial Word64

type Rep (Snowflake t)

Defined in Calamity.Types.Snowflake

type Rep (Snowflake t) = Rep Word64

class HasID b a where

A typeclass for types that contain snowflakes of type b

Methods

getID :: a -> Snowflake b

Retrieve the ID from the type

Instances

HasID Channel FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake Channel

HasID Channel LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake Channel

HasID Channel ReactionEvtData

Defined in Calamity.Gateway.DispatchEvents

Methods

getID :: ReactionEvtData -> Snowflake Channel

HasID Channel Channel

Defined in Calamity.Types.Model.Channel

Methods

getID :: Channel -> Snowflake Channel

HasID Channel DMChannel

Defined in Calamity.Types.Model.Channel.DM

Methods

getID :: DMChannel -> Snowflake Channel

HasID Channel GroupChannel

Defined in Calamity.Types.Model.Channel.Group

Methods

getID :: GroupChannel -> Snowflake Channel

HasID Channel GuildChannel

Defined in Calamity.Types.Model.Channel.Guild

Methods

getID :: GuildChannel -> Snowflake Channel

HasID Channel Category

Defined in Calamity.Types.Model.Channel.Guild.Category

Methods

getID :: Category -> Snowflake Channel

HasID Channel TextChannel

Defined in Calamity.Types.Model.Channel.Guild.Text

Methods

getID :: TextChannel -> Snowflake Channel

HasID Channel VoiceChannel

Defined in Calamity.Types.Model.Channel.Guild.Voice

Methods

getID :: VoiceChannel -> Snowflake Channel

HasID Channel ChannelMention

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: ChannelMention -> Snowflake Channel

HasID Channel Message

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: Message -> Snowflake Channel

HasID Channel UpdatedMessage

Defined in Calamity.Types.Model.Channel.UpdatedMessage

Methods

getID :: UpdatedMessage -> Snowflake Channel

HasID Attachment Attachment

Defined in Calamity.Types.Model.Channel.Attachment

Methods

getID :: Attachment -> Snowflake Attachment

HasID DMChannel DMChannel

Defined in Calamity.Types.Model.Channel.DM

Methods

getID :: DMChannel -> Snowflake DMChannel

HasID GroupChannel GroupChannel

Defined in Calamity.Types.Model.Channel.Group

Methods

getID :: GroupChannel -> Snowflake GroupChannel

HasID GuildChannel GuildChannel

Defined in Calamity.Types.Model.Channel.Guild

Methods

getID :: GuildChannel -> Snowflake GuildChannel

HasID Category Category

Defined in Calamity.Types.Model.Channel.Guild.Category

Methods

getID :: Category -> Snowflake Category

HasID TextChannel TextChannel

Defined in Calamity.Types.Model.Channel.Guild.Text

Methods

getID :: TextChannel -> Snowflake TextChannel

HasID VoiceChannel VoiceChannel

Defined in Calamity.Types.Model.Channel.Guild.Voice

Methods

getID :: VoiceChannel -> Snowflake VoiceChannel

HasID Message FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake Message

HasID Message LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake Message

HasID Message ReactionEvtData

Defined in Calamity.Gateway.DispatchEvents

Methods

getID :: ReactionEvtData -> Snowflake Message

HasID Message Message

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: Message -> Snowflake Message

HasID Message UpdatedMessage

Defined in Calamity.Types.Model.Channel.UpdatedMessage

Methods

getID :: UpdatedMessage -> Snowflake Message

HasID Webhook MessageAuthorWebhook

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: MessageAuthorWebhook -> Snowflake Webhook

HasID Webhook Webhook

Defined in Calamity.Types.Model.Channel.Webhook

Methods

getID :: Webhook -> Snowflake Webhook

HasID AuditLogEntry AuditLogEntry

Defined in Calamity.Types.Model.Guild.AuditLog

Methods

getID :: AuditLogEntry -> Snowflake AuditLogEntry

HasID Emoji Emoji

Defined in Calamity.Types.Model.Guild.Emoji

Methods

getID :: Emoji -> Snowflake Emoji

HasID Guild GuildChannel

Defined in Calamity.Types.Model.Channel.Guild

Methods

getID :: GuildChannel -> Snowflake Guild

HasID Guild TextChannel

Defined in Calamity.Types.Model.Channel.Guild.Text

Methods

getID :: TextChannel -> Snowflake Guild

HasID Guild VoiceChannel

Defined in Calamity.Types.Model.Channel.Guild.Voice

Methods

getID :: VoiceChannel -> Snowflake Guild

HasID Guild BanData

Defined in Calamity.Types.Model.Guild.Ban

Methods

getID :: BanData -> Snowflake Guild

HasID Guild Guild

Defined in Calamity.Types.Model.Guild.Guild

Methods

getID :: Guild -> Snowflake Guild

HasID Guild UpdatedGuild

Defined in Calamity.Types.Model.Guild.Guild

Methods

getID :: UpdatedGuild -> Snowflake Guild

HasID Guild UnavailableGuild

Defined in Calamity.Types.Model.Guild.UnavailableGuild

Methods

getID :: UnavailableGuild -> Snowflake Guild

HasID Guild Presence

Defined in Calamity.Types.Model.Presence.Presence

Methods

getID :: Presence -> Snowflake Guild

HasID Member Member

Defined in Calamity.Types.Model.Guild.Member

Methods

getID :: Member -> Snowflake Member

HasID Member User

Defined in Calamity.Types.Model.User

Methods

getID :: User -> Snowflake Member

HasID Overwrite Overwrite

Defined in Calamity.Types.Model.Guild.Overwrite

Methods

getID :: Overwrite -> Snowflake Overwrite

HasID Role Role

Defined in Calamity.Types.Model.Guild.Role

Methods

getID :: Role -> Snowflake Role

HasID Application Interaction

Defined in Calamity.Types.Model.Interaction

Methods

getID :: Interaction -> Snowflake Application

HasID Interaction Interaction

Defined in Calamity.Types.Model.Interaction

Methods

getID :: Interaction -> Snowflake Interaction

HasID User FullContext

Defined in Calamity.Commands.Context

Methods

getID :: FullContext -> Snowflake User

HasID User LightContext

Defined in Calamity.Commands.Context

Methods

getID :: LightContext -> Snowflake User

HasID User ReactionEvtData

Defined in Calamity.Gateway.DispatchEvents

Methods

getID :: ReactionEvtData -> Snowflake User

HasID User GroupChannel

Defined in Calamity.Types.Model.Channel.Group

Methods

getID :: GroupChannel -> Snowflake User

HasID User Message

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: Message -> Snowflake User

HasID User MessageAuthor

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: MessageAuthor -> Snowflake User

HasID User AuditLogEntry

Defined in Calamity.Types.Model.Guild.AuditLog

Methods

getID :: AuditLogEntry -> Snowflake User

HasID User BanData

Defined in Calamity.Types.Model.Guild.Ban

Methods

getID :: BanData -> Snowflake User

HasID User Member

Defined in Calamity.Types.Model.Guild.Member

Methods

getID :: Member -> Snowflake User

HasID User Presence

Defined in Calamity.Types.Model.Presence.Presence

Methods

getID :: Presence -> Snowflake User

HasID User User

Defined in Calamity.Types.Model.User

Methods

getID :: User -> Snowflake User

HasID Channel (Partial Channel)

Defined in Calamity.Types.Model.Channel

Methods

getID :: Partial Channel -> Snowflake Channel

HasID Channel (Partial Message)

Defined in Calamity.Types.Model.Channel.Message

Methods

getID :: Partial Message -> Snowflake Channel

HasID Emoji (Partial Emoji)

Defined in Calamity.Types.Model.Guild.Emoji

Methods

getID :: Partial Emoji -> Snowflake Emoji

HasID Guild (Partial Guild)

Defined in Calamity.Types.Model.Guild.Guild

Methods

getID :: Partial Guild -> Snowflake Guild

HasID User (Partial User)

Defined in Calamity.Types.Model.User

Methods

getID :: Partial User -> Snowflake User

HasID a (Snowflake a)

Defined in Calamity.Types.Snowflake

Methods

getID :: Snowflake a -> Snowflake a

(HasID b c, HasField field a c) => HasID b (HasIDField field a)

Defined in Calamity.Types.Snowflake

Methods

getID :: HasIDField field a -> Snowflake b

(HasID c d, HasField field a d) => HasID b (HasIDFieldCoerce field a c)

Defined in Calamity.Types.Snowflake

Methods

getID :: HasIDFieldCoerce field a c -> Snowflake b

type HasID' a = HasID a a

newtype HasIDField field a

A newtype wrapper for deriving HasID generically

Constructors

HasIDField a

Instances

(HasID b c, HasField field a c) => HasID b (HasIDField field a)

Defined in Calamity.Types.Snowflake

Methods

getID :: HasIDField field a -> Snowflake b

newtype HasIDFieldCoerce field a c

A data a which contains an ID of type `Snowflake c` which should be swapped with `Snowflake b` upon fetching

Constructors

HasIDFieldCoerce a

Instances

(HasID c d, HasField field a d) => HasID b (HasIDFieldCoerce field a c)

Defined in Calamity.Types.Snowflake

Methods

getID :: HasIDFieldCoerce field a c -> Snowflake b

type HasIDFieldCoerce' field a = HasIDFieldCoerce field a a

coerceSnowflake :: Snowflake a -> Snowflake b