glyde/id

Discord IDs, called snowflakes. Always a String: Discord sends them as JSON strings and nothing ever does arithmetic on one.

Each is tagged with what it identifies, so swapping the two snowflakes in /channels/{channel_id}/messages/{message_id} will not compile.

Types

Application

</>

pub type Application

ApplicationId

</>

pub type ApplicationId =
  Id(Application)

Attachment

</>

pub type Attachment

AttachmentId

</>

pub type AttachmentId =
  Id(Attachment)

Channel

</>

pub type Channel

ChannelId

</>

pub type ChannelId =
  Id(Channel)

Command

</>

An application command, called a slash command in the UI.

pub type Command

CommandId

</>

pub type CommandId =
  Id(Command)

Emoji

</>

pub type Emoji

EmojiId

</>

pub type EmojiId =
  Id(Emoji)

Guild

</>

pub type Guild

GuildId

</>

pub type GuildId =
  Id(Guild)

Id

opaque </>

pub opaque type Id(kind)

Integration

</>

A guild integration, such as a linked Twitch or YouTube account.

pub type Integration

IntegrationId

</>

pub type IntegrationId =
  Id(Integration)

Interaction

</>

pub type Interaction

InteractionId

</>

pub type InteractionId =
  Id(Interaction)

Message

</>

pub type Message

MessageId

</>

pub type MessageId =
  Id(Message)

Overwrite

</>

A permission overwrite, which is addressed by the id of the role or member it applies to. model/channel.OverwriteTarget says which of the two.

pub type Overwrite

OverwriteId

</>

pub type OverwriteId =
  Id(Overwrite)

Role

</>

pub type Role

RoleId

</>

pub type RoleId =
  Id(Role)

ScheduledEvent

</>

pub type ScheduledEvent

ScheduledEventId

</>

pub type ScheduledEventId =
  Id(ScheduledEvent)

Sku

</>

A monetisation SKU.

pub type Sku

SkuId

</>

pub type SkuId =
  Id(Sku)

Sticker

</>

pub type Sticker

StickerId

</>

pub type StickerId =
  Id(Sticker)

SubscriptionListing

</>

A subscription listing, used by role subscriptions.

pub type SubscriptionListing

SubscriptionListingId

</>

pub type SubscriptionListingId =
  Id(SubscriptionListing)

Tag

opaque </>

Names a tag as a value, so retag can be told which one to produce. Empty and opaque: the constants below are the only ones there are.

pub opaque type Tag(kind)

User

</>

pub type User

UserId

</>

pub type UserId =
  Id(User)

Webhook

</>

pub type Webhook

WebhookId

</>

pub type WebhookId =
  Id(Webhook)

Values

application

</>

pub const application: Tag(Application)

attachment

</>

pub const attachment: Tag(Attachment)

channel

</>

pub const channel: Tag(Channel)

command

</>

pub const command: Tag(Command)

compare

</>

pub fn compare(a: Id(kind), b: Id(kind)) -> order.Order

Numerically, which for snowflakes is oldest first. Length first because string order is wrong: IDs run 15 to 19 digits with no leading zero.

created_at_ms

</>

pub fn created_at_ms(id: Id(kind)) -> Result(Int, Nil)

When this thing was created, in milliseconds since the Unix epoch. Error when the ID is not a snowflake: not a number at all, or wider than one. parse rejects both, so only an ID minted with from_string can fail.

created_at_ms_or

</>

pub fn created_at_ms_or(
  id: Id(kind),
  default default: Int,
) -> Int

created_at_ms for a caller that has to answer with a number either way. discord_epoch_ms is usually the default to reach for: it reads as the oldest snowflake there is, so an ID that is not one sorts as ancient rather than as this instant.

decoder

</>

pub fn decoder() -> decode.Decoder(Id(kind))

Strings only: Discord always sends a snowflake as a JSON string, so a number in that slot is a malformed payload.

discord_epoch_ms

</>

pub const discord_epoch_ms: Int

Discord’s epoch, 2015-01-01T00:00:00Z, in milliseconds.

emoji

</>

pub const emoji: Tag(Emoji)

from_string

</>

pub fn from_string(text: String) -> Id(kind)

An ID minted from a string you trust: a literal, or text you have already checked. Does not validate, and IDs go straight into request paths, so parse anything that came from outside.

guild

</>

pub const guild: Tag(Guild)

integration

</>

pub const integration: Tag(Integration)

interaction

</>

pub const interaction: Tag(Interaction)

message

</>

pub const message: Tag(Message)

overwrite

</>

pub const overwrite: Tag(Overwrite)

parse

</>

pub fn parse(text: String) -> Result(Id(kind), Nil)

An ID from untrusted input: digits only, no leading zero and no wider than a snowflake, which is every ID Discord issues. Rejects @me and anything with a path separator.

retag

</>

pub fn retag(id: Id(a), to tag: Tag(b)) -> Id(b)

The same ID under a different tag, for the places Discord hands one thing out under two names. Only relabels an ID you already hold: unlike from_string it cannot bring new text in.

The destination is a tag value rather than inference, so the call site says what it is making and the compiler holds you to it:

id.retag(overwrite.id, to: id.role)

role

</>

pub const role: Tag(Role)

scheduled_event

</>

pub const scheduled_event: Tag(ScheduledEvent)

sku

</>

pub const sku: Tag(Sku)

sticker

</>

pub const sticker: Tag(Sticker)

subscription_listing

</>

pub const subscription_listing: Tag(SubscriptionListing)

to_json

</>

pub fn to_json(id: Id(kind)) -> json.Json

to_string

</>

pub fn to_string(id: Id(kind)) -> String

user

</>

pub const user: Tag(User)

webhook

</>

pub const webhook: Tag(Webhook)