🥮 mooncakes.io
    Sign in

    gaato/discord/bot does not have a README file

    EventMiddleware

    source
    type EventMiddleware = async (GatewayCtx, 
    Event    , async (
    Event    ) -> Unit) -> Unit

    Runs once per decoded gateway event, around the handler fan-out. next(event) spawns the typed and raw handlers for (a possibly transformed) event and returns once they are spawned, not completed. Not calling next drops the event for handlers only: cache updates, decode-error observation, collectors, and interaction routing are wire-level machinery that runs before this chain.

    BotConfigError

    source
    pub(all) suberror BotConfigError {
      EmptyToken
      InvalidShardConfig(message~ : String)
      MismatchedSession(shard_id~ : Int)
      InvalidEventBacklog(value~ : Int)
      InvalidShutdownGrace(value~ : Int)
      InvalidMaxMessageBytes(value~ : Int)
    } derive(
    Debug    )

    A gateway configuration that cannot run, found by BotBuilder::build before any connection is attempted.

    BotError

    source
    pub(all) suberror BotError {
      FatallyClosed(code~ : Int)
      AlreadyRunning
      InvalidGatewayInfo(message~ : String)
      SessionStartLimitExceeded(required~ : Int, remaining~ : Int, reset_after_ms~ : Int64)
      ShardNotManaged(shard_id~ : Int)
      GatewayRateLimited(opcode~ : Int, retry_after_ms~ : Int64)
      GatewayRequestTimeout
    } derive(
    Debug    )

    Fatal runtime failures reported by Discord.
    impl Show for BotError

    BotError::to_string

    source
    fn BotError::to_string(self : BotError) -> String

    Bot

    source
    pub struct Bot {
      // private fields
    }

    A validated gateway bot, built by BotBuilder::build. Its configuration and registrations are fixed; run connects it.

    Bot::run

    source
    async fn Bot::run(self : Bot) -> Unit

    Connect and process gateway events until graceful shutdown or a fatal close. Raises BotError::AlreadyRunning when this bot is already running; it may run again after run returns. Other failures are connection-time: REST errors from GET /gateway/bot or the command sync, BotError for a fatal gateway close, an exhausted session start limit, or unusable gateway information.

    Bot::sessions

    source
    fn Bot::sessions(self : Bot) -> Map[Int, BotSession]

    Current resumable gateway state paired with READY metadata, keyed by shard id. A supplied snapshot is available from the start of run until its shard replaces, drops, or invalidates it, including while run still resolves the shard layout over REST; an unsaved shard appears after READY. Empty while the bot is not running. Returned values do not alias mutable runtime state.

    BotBuilder

    source
    pub struct BotBuilder {
      // private fields
    }

    Collects a gateway bot's configuration and registrations: typed and raw event handlers, event middleware, services, the cache, and observers. build() validates it into a Bot that can run. Like AppBuilder, registering more on the builder afterwards does not change a built Bot.

    BotBuilder::BotBuilder

    source
    fn BotBuilder::BotBuilder(app : 
    App    , token~ : String, intents? : 
    Intents    , capabilities? : 
    GatewayCapabilities    , client? : 
    Client    , gateway_url? : String, shards? : ShardConfig, compress? : Bool, compression? : 
    GatewayCompression    , identify_queue? : &
    IdentifyQueue    , sync? : 
    CommandScope    , sync_unowned? : 
    UnownedCommands    , resume? : Map[Int, BotSession], event_backlog? : Int, shutdown_grace_ms? : Int, max_message_bytes? : Int) -> BotBuilder

    Configure a gateway bot for app. When intents is omitted, build infers the union of intents required by the typed event subscriptions (privileged intents are only inferred, never invented — they must still be enabled in the developer portal). client supplies a preconfigured REST client; by default one is built from token. shards, compression, and identify_queue configure sharding, transport compression, and cross-process identify coordination; compress=true is the older spelling of compression=ZlibStream, and compression wins when both are given. Every IDENTIFY, at startup or after a lost session, first reads session_start_limit from GET /gateway/bot; an exhausted limit ends run with SessionStartLimitExceeded instead of risking a token reset. capabilities is sent in Identify (see @model.GatewayCapabilities).

    When sync is omitted, the bot performs no command synchronization. When set, synchronization runs once per process after the first READY. It uses Discord's bulk overwrite: every command in that scope that this App does not declare is deleted, except entry points, which are always preserved. sync_unowned=Keep also preserves commands registered by other owners. Deletions are reported through the app's warning hook. In multi-process sharding, enable synchronization in exactly one process.

    resume seeds saved Bot sessions per shard id so those shards RESUME instead of identifying (see Bot::sessions). It restores gateway identity, not optional cache contents or application-owned state.

    event_backlog caps the decoded events waiting for event middleware and handlers (default DEFAULT_EVENT_BACKLOG). When handlers fall that far behind, further events skip them — with an EventDropped telemetry event each and one warning per overload — until they catch up. The cache and interaction routing never wait in this backlog.

    After a requested shutdown, run waits up to shutdown_grace_ms for event and interaction handlers that are still running, then cancels them with a warning (default DEFAULT_SHUTDOWN_GRACE_MS); handlers that had not started by the request never do (see GatewayCtx::shutdown). max_message_bytes bounds one Gateway message, compressed or inflated; a larger one ends the connection and the shard resumes.

    BotBuilder::attach_cache

    source

    Feed every decoded gateway event into an opt-in cache before dispatching typed and raw event handlers.

    BotBuilder::build

    source
    fn BotBuilder::build(self : BotBuilder) -> Bot raise BotConfigError

    Validate the configuration and freeze the registrations into a Bot. Raises BotConfigError for an empty token, a shard selection Discord cannot represent, a saved session whose ids disagree, an event_backlog below 1, a negative shutdown_grace_ms, or a max_message_bytes below 1. Intents are resolved here, so warnings about subscriptions the intents cannot deliver appear once, at build time.

    BotBuilder::middleware

    source
    fn BotBuilder::middleware(self : BotBuilder, middleware : async (GatewayCtx, 
    Event    , async (
    Event    ) -> Unit) -> Unit) -> Unit

    Install gateway event middleware. The first installed middleware is outermost. The chain runs serially, in event order, in a dispatch task separate from the shard loop: slow middleware delays later events, never interaction routing. A dropped event emits no EventDispatched telemetry. Middleware cannot widen intents or the gateway event filter.

    BotBuilder::on

    source
    fn[T] BotBuilder::on(self : BotBuilder, event : EventType[T], handler : async (GatewayCtx, T) -> Unit) -> Unit

    Subscribe a typed handler to one gateway event (see Events for the descriptors). The event's required intents join the inferred intent set when the builder omits explicit intents. Handlers run through the event middleware chain; a raised error is reported via the app's failure policy without stopping the bot.

    BotBuilder::on_decode_error

    source
    fn BotBuilder::on_decode_error(self : BotBuilder, handler : (String, Json) -> Unit) -> Unit

    Observe gateway events whose known payload failed typed decoding.

    marker is the full synthetic event type DECODE_ERROR:<event-name>:<decode-error>, and payload is Discord's raw event data. Handlers run synchronously in the dispatch loop and should return promptly. Registering a handler does not add gateway intents or widen the event filter.

    BotBuilder::on_event

    source
    fn BotBuilder::on_event(self : BotBuilder, handler : async (GatewayCtx, 
    Event    ) -> Unit) -> Unit

    Subscribe to the raw event stream: every decoded gateway dispatch, including Resumed and Unknown, without payload projection. Unlike on, this adds nothing to the inferred intent set.

    BotBuilder::on_telemetry

    source
    fn BotBuilder::on_telemetry(self : BotBuilder, hook : (
    TelemetryEvent    ) -> Unit raise) -> Unit

    Observe structured gateway, dispatch, and REST telemetry aggregated by this bot. Hooks run synchronously and should return promptly.

    BotBuilder::presence

    source

    Set the initial presence used by every shard managed by this process.

    BotBuilder::service

    source
    fn BotBuilder::service(self : BotBuilder, name~ : String, handler : async (GatewayCtx) -> Unit) -> Unit

    Register a long-running background task started alongside the shards when the bot runs (e.g. a periodic status updater). name labels the service in failure reports. A raised error is reported via the app's failure policy and stops only that service, not the bot.

    BotSession

    source

    Persist a Bot gateway session together with the READY identity needed to restore event and interaction handling before Discord sends RESUMED. Optional cache contents and application-owned state are not restored. Persisting a receive sequence periodically does not guarantee exactly-once event handling after a restart.

    BotSession::to_json

    source
    fn BotSession::to_json(BotSession) -> Json

    EventType

    source
    pub struct EventType[T] {
      // private fields
    }

    A typed projection from the general gateway event enum.

    EventType::kind

    source

    The untyped event kind used by gateway filtering and intent calculation.

    EventType::project

    source
    fn[T] EventType::project(self : EventType[T], event : 
    Event    ) -> T?

    Extract the typed payload when event is this descriptor's variant.

    EventType::required_intents

    source
    fn[T] EventType::required_intents(self : EventType[T]) -> 
    Intents

    Gateway intents that can deliver this event.

    Events

    source
    pub struct Events {
    }

    Namespace for typed gateway event descriptors.

    The payload-free Resumed event and Unknown are available only through the low-level event stream.

    Events::application_command_permissions_update

    source

    Typed descriptor for APPLICATION_COMMAND_PERMISSIONS_UPDATE — the permission overwrites of an application command were updated. Not gated by a gateway intent.

    Events::auto_moderation_action_execution

    source

    Typed descriptor for AUTO_MODERATION_ACTION_EXECUTION — an auto moderation rule triggered and its action was executed. Delivered under the AUTO_MODERATION_EXECUTION intent.

    Events::auto_moderation_rule_create

    source

    Typed descriptor for AUTO_MODERATION_RULE_CREATE — an auto moderation rule was created. Delivered under the AUTO_MODERATION_CONFIGURATION intent.

    Events::auto_moderation_rule_delete

    source

    Typed descriptor for AUTO_MODERATION_RULE_DELETE — an auto moderation rule was deleted. Delivered under the AUTO_MODERATION_CONFIGURATION intent.

    Events::auto_moderation_rule_update

    source

    Typed descriptor for AUTO_MODERATION_RULE_UPDATE — an auto moderation rule was updated. Delivered under the AUTO_MODERATION_CONFIGURATION intent.

    Events::channel_create

    source

    Typed descriptor for CHANNEL_CREATE — a guild channel was created. Delivered under the GUILDS intent.

    Events::channel_delete

    source

    Typed descriptor for CHANNEL_DELETE — a guild channel was deleted. Delivered under the GUILDS intent.

    Events::channel_info

    source

    Typed descriptor for CHANNEL_INFO — ephemeral voice-channel status and session data for a guild's channels. Not gated by a gateway intent.

    Events::channel_pins_update

    source

    Typed descriptor for CHANNEL_PINS_UPDATE — a message was pinned or unpinned (not fired when a pinned message is deleted). Delivered under the GUILDS or DIRECT_MESSAGES intent.

    Events::channel_update

    source

    Typed descriptor for CHANNEL_UPDATE — a guild channel was updated. Delivered under the GUILDS intent.

    Events::entitlement_create

    source

    Typed descriptor for ENTITLEMENT_CREATE — an entitlement was created, e.g. a user purchased or was granted a premium offering. Not gated by a gateway intent.

    Events::entitlement_delete

    source

    Typed descriptor for ENTITLEMENT_DELETE — an entitlement was deleted, e.g. Discord refunded or revoked it (not fired on normal expiry). Not gated by a gateway intent.

    Events::entitlement_update

    source

    Typed descriptor for ENTITLEMENT_UPDATE — an entitlement was renewed or ended. Not gated by a gateway intent.

    Events::guild_audit_log_entry_create

    source

    Typed descriptor for GUILD_AUDIT_LOG_ENTRY_CREATE — an audit log entry was created. Delivered under the GUILD_MODERATION intent; the bot also needs the View Audit Log permission.

    Events::guild_ban_add

    source

    Typed descriptor for GUILD_BAN_ADD — a user was banned from a guild. Delivered under the GUILD_MODERATION intent.

    Events::guild_ban_remove

    source

    Typed descriptor for GUILD_BAN_REMOVE — a user was unbanned from a guild. Delivered under the GUILD_MODERATION intent.

    Events::guild_create

    source

    Typed descriptor for GUILD_CREATE — the initial lazy-load of each guild after READY, a guild becoming available again, or the bot joining a new guild. Delivered under the GUILDS intent.

    Events::guild_delete

    source

    Typed descriptor for GUILD_DELETE — the bot was removed from a guild, or the guild became unavailable during an outage (check the unavailable field to tell the two apart). Delivered under the GUILDS intent.

    Events::guild_emojis_update

    source

    Typed descriptor for GUILD_EMOJIS_UPDATE — a guild's custom emoji set changed. Delivered under the GUILD_EXPRESSIONS intent.

    Events::guild_integrations_update

    source

    Typed descriptor for GUILD_INTEGRATIONS_UPDATE — a guild integration was created, updated, or deleted. Delivered under the GUILD_INTEGRATIONS intent.

    Events::guild_member_add

    source

    Typed descriptor for GUILD_MEMBER_ADD — a user joined a guild. Delivered under the privileged GUILD_MEMBERS intent.

    Events::guild_member_remove

    source

    Typed descriptor for GUILD_MEMBER_REMOVE — a user left a guild, or was kicked or banned. Delivered under the privileged GUILD_MEMBERS intent.

    Events::guild_member_update

    source

    Typed descriptor for GUILD_MEMBER_UPDATE — a guild member was updated (roles, nick, timeout, ...). Delivered under the privileged GUILD_MEMBERS intent.

    Events::guild_members_chunk

    source

    Typed descriptor for GUILD_MEMBERS_CHUNK — one page of the response to a Request Guild Members gateway command. Not gated by a gateway intent.

    Events::guild_role_create

    source

    Typed descriptor for GUILD_ROLE_CREATE — a role was created. Delivered under the GUILDS intent.

    Events::guild_role_delete

    source

    Typed descriptor for GUILD_ROLE_DELETE — a role was deleted. Delivered under the GUILDS intent.

    Events::guild_role_update

    source

    Typed descriptor for GUILD_ROLE_UPDATE — a role was updated. Delivered under the GUILDS intent.

    Events::guild_scheduled_event_create

    source

    Typed descriptor for GUILD_SCHEDULED_EVENT_CREATE — a scheduled event was created. Delivered under the GUILD_SCHEDULED_EVENTS intent.

    Events::guild_scheduled_event_delete

    source

    Typed descriptor for GUILD_SCHEDULED_EVENT_DELETE — a scheduled event was deleted. Delivered under the GUILD_SCHEDULED_EVENTS intent.

    Events::guild_scheduled_event_update

    source

    Typed descriptor for GUILD_SCHEDULED_EVENT_UPDATE — a scheduled event was updated. Delivered under the GUILD_SCHEDULED_EVENTS intent.

    Events::guild_scheduled_event_user_add

    source

    Typed descriptor for GUILD_SCHEDULED_EVENT_USER_ADD — a user subscribed to a scheduled event. Delivered under the GUILD_SCHEDULED_EVENTS intent.

    Events::guild_scheduled_event_user_remove

    source

    Typed descriptor for GUILD_SCHEDULED_EVENT_USER_REMOVE — a user unsubscribed from a scheduled event. Delivered under the GUILD_SCHEDULED_EVENTS intent.

    Events::guild_soundboard_sound_create

    source

    Typed descriptor for GUILD_SOUNDBOARD_SOUND_CREATE — a soundboard sound was created. Delivered under the GUILD_EXPRESSIONS intent.

    Events::guild_soundboard_sound_delete

    source

    Typed descriptor for GUILD_SOUNDBOARD_SOUND_DELETE — a soundboard sound was deleted. Delivered under the GUILD_EXPRESSIONS intent.

    Events::guild_soundboard_sound_update

    source

    Typed descriptor for GUILD_SOUNDBOARD_SOUND_UPDATE — a soundboard sound was updated. Delivered under the GUILD_EXPRESSIONS intent.

    Events::guild_soundboard_sounds_update

    source

    Typed descriptor for GUILD_SOUNDBOARD_SOUNDS_UPDATE — multiple soundboard sounds were updated at once. Delivered under the GUILD_EXPRESSIONS intent.

    Events::guild_stickers_update

    source

    Typed descriptor for GUILD_STICKERS_UPDATE — a guild's sticker set changed. Delivered under the GUILD_EXPRESSIONS intent.

    Events::guild_update

    source

    Typed descriptor for GUILD_UPDATE — a guild's settings were updated. Delivered under the GUILDS intent.

    Events::integration_create

    source

    Typed descriptor for INTEGRATION_CREATE — an integration was created in a guild. Delivered under the GUILD_INTEGRATIONS intent.

    Events::integration_delete

    source

    Typed descriptor for INTEGRATION_DELETE — an integration was deleted from a guild. Delivered under the GUILD_INTEGRATIONS intent.

    Events::integration_update

    source

    Typed descriptor for INTEGRATION_UPDATE — an integration was updated in a guild. Delivered under the GUILD_INTEGRATIONS intent.

    Events::interaction_create

    source

    Typed descriptor for INTERACTION_CREATE — a user invoked a slash command, component, modal, or autocomplete. Not gated by a gateway intent. Most bots should route interactions through App::attach instead of subscribing to this event directly.

    Events::invite_create

    source

    Typed descriptor for INVITE_CREATE — an invite to a channel was created. Delivered under the GUILD_INVITES intent; the bot also needs the Manage Channels permission on the channel.

    Events::invite_delete

    source

    Typed descriptor for INVITE_DELETE — an invite to a channel was deleted. Delivered under the GUILD_INVITES intent; the bot also needs the Manage Channels permission on the channel.

    Events::message_create

    source

    Typed descriptor for MESSAGE_CREATE — a message was sent. Delivered under the GUILD_MESSAGES or DIRECT_MESSAGES intent; content, embeds, attachments, and components stay empty in guilds unless the privileged MESSAGE_CONTENT intent is also enabled.

    Events::message_delete

    source

    Typed descriptor for MESSAGE_DELETE — a message was deleted. Delivered under the GUILD_MESSAGES or DIRECT_MESSAGES intent.

    Events::message_delete_bulk

    source

    Typed descriptor for MESSAGE_DELETE_BULK — multiple messages were deleted at once. Delivered under the GUILD_MESSAGES intent.

    Events::message_poll_vote_add

    source

    Typed descriptor for MESSAGE_POLL_VOTE_ADD — a user voted on a poll. Delivered under the GUILD_MESSAGE_POLLS or DIRECT_MESSAGE_POLLS intent.

    Events::message_poll_vote_remove

    source

    Typed descriptor for MESSAGE_POLL_VOTE_REMOVE — a user removed a poll vote. Delivered under the GUILD_MESSAGE_POLLS or DIRECT_MESSAGE_POLLS intent.

    Events::message_reaction_add

    source

    Typed descriptor for MESSAGE_REACTION_ADD.

    A classic use is reaction roles: subscribe to reaction add and remove events, identify the configured emoji, then update the member role through the REST client. The bot needs the Manage Roles permission, and its highest role must be above the assigned role. Typed subscriptions infer the non-privileged reaction delivery intents when BotBuilder(...) omits an explicit intents value; if intents are explicit, include Intents::guild_message_reactions(). Production handlers should also restrict the configured message and channel IDs and make the add/remove operations idempotent at the application level.

    test "install a reaction role feature" {
      fn install_reaction_role(
        bot : @bot.BotBuilder,
        role_id : @model.RoleId,
      ) -> Unit {
        bot.on(@bot.Events::message_reaction_add(), (ctx, event) => {
          guard event.guild_id is Some(guild_id) else { return }
          guard event.emoji.name.to_option() == Some("✅") else { return }
          if event.user_id == ctx.ready().user.id {
            return
          }
          ctx
          .app()
          .http()
          .add_member_role(
            guild_id,
            event.user_id,
            role_id,
            audit_reason="reaction role",
          )
        })
        bot.on(@bot.Events::message_reaction_remove(), (ctx, event) => {
          guard event.guild_id is Some(guild_id) else { return }
          guard event.emoji.name.to_option() == Some("✅") else { return }
          ctx
          .app()
          .http()
          .remove_member_role(
            guild_id,
            event.user_id,
            role_id,
            audit_reason="reaction role removed",
          )
        })
      }

      ignore(install_reaction_role)
    }

    Events::message_reaction_remove

    source

    Typed descriptor for MESSAGE_REACTION_REMOVE — a user removed a reaction from a message. Delivered under the GUILD_MESSAGE_REACTIONS or DIRECT_MESSAGE_REACTIONS intent. See Events::message_reaction_add for a worked reaction-role example.

    Events::message_reaction_remove_all

    source

    Typed descriptor for MESSAGE_REACTION_REMOVE_ALL — all reactions were cleared from a message. Delivered under the GUILD_MESSAGE_REACTIONS or DIRECT_MESSAGE_REACTIONS intent.

    Events::message_reaction_remove_emoji

    source

    Typed descriptor for MESSAGE_REACTION_REMOVE_EMOJI — all reactions for a single emoji were cleared from a message. Delivered under the GUILD_MESSAGE_REACTIONS or DIRECT_MESSAGE_REACTIONS intent.

    Events::message_update

    source

    Typed descriptor for MESSAGE_UPDATE — a message was edited (also fired for embed unfurls and other partial edits). Delivered under the GUILD_MESSAGES or DIRECT_MESSAGES intent; content visibility follows the same MESSAGE_CONTENT rule as MESSAGE_CREATE. before is present only when the bot's messages cache is enabled and the previous revision is still within its retention window.

    Events::presence_update

    source

    Typed descriptor for PRESENCE_UPDATE — a member's presence (status or activities) changed. Delivered under the privileged GUILD_PRESENCES intent.

    Events::rate_limited

    source

    Typed descriptor for RATE_LIMITED — the gateway rejected a command sent by this shard and reported when it may retry. Not gated by a gateway intent.

    Events::ready

    source

    Typed descriptor for READY — the initial state after identify completes: the bot user, unavailable guilds, and session resume data. Fired once per session (including after reconnects that re-identify). Not gated by a gateway intent.

    Events::soundboard_sounds

    source

    Typed descriptor for SOUNDBOARD_SOUNDS — the response to a Request Soundboard Sounds gateway command. Not gated by a gateway intent.

    Events::stage_instance_create

    source

    Typed descriptor for STAGE_INSTANCE_CREATE — a stage instance (live stage) was created. Delivered under the GUILDS intent.

    Events::stage_instance_delete

    source

    Typed descriptor for STAGE_INSTANCE_DELETE — a stage instance was deleted. Delivered under the GUILDS intent.

    Events::stage_instance_update

    source

    Typed descriptor for STAGE_INSTANCE_UPDATE — a stage instance was updated. Delivered under the GUILDS intent.

    Events::subscription_create

    source

    Typed descriptor for SUBSCRIPTION_CREATE — a premium app subscription was created. Not gated by a gateway intent.

    Events::subscription_delete

    source

    Typed descriptor for SUBSCRIPTION_DELETE — a premium app subscription was deleted. Not gated by a gateway intent.

    Events::subscription_update

    source

    Typed descriptor for SUBSCRIPTION_UPDATE — a premium app subscription was updated, e.g. renewed or ended. Not gated by a gateway intent.

    Events::thread_create

    source

    Typed descriptor for THREAD_CREATE — a thread was created, or the bot was added to a private thread. Delivered under the GUILDS intent.

    Events::thread_delete

    source

    Typed descriptor for THREAD_DELETE — a thread was deleted. Delivered under the GUILDS intent.

    Events::thread_list_sync

    source

    Typed descriptor for THREAD_LIST_SYNC — the active threads of one or more channels were synced after the bot gained access to them. Delivered under the GUILDS intent.

    Events::thread_member_update

    source

    Typed descriptor for THREAD_MEMBER_UPDATE — the bot's own thread member object was updated. Delivered under the GUILDS intent.

    Events::thread_members_update

    source

    Typed descriptor for THREAD_MEMBERS_UPDATE — users were added to or removed from a thread. With only the GUILDS intent this fires for changes involving the bot itself; the privileged GUILD_MEMBERS intent extends it to all users.

    Events::thread_update

    source

    Typed descriptor for THREAD_UPDATE — a thread was updated. Delivered under the GUILDS intent.

    Events::typing_start

    source

    Typed descriptor for TYPING_START — a user started typing in a channel. Delivered under the GUILD_MESSAGE_TYPING or DIRECT_MESSAGE_TYPING intent.

    Events::user_update

    source

    Typed descriptor for USER_UPDATE — the bot's own user object was updated. Not gated by a gateway intent.

    Events::voice_channel_effect_send

    source

    Typed descriptor for VOICE_CHANNEL_EFFECT_SEND — someone sent an emoji or soundboard effect in a voice channel. Delivered under the GUILD_VOICE_STATES intent.

    Events::voice_channel_start_time_update

    source

    Typed descriptor for VOICE_CHANNEL_START_TIME_UPDATE — a voice channel's session start time changed. Delivered under the GUILDS intent.

    Events::voice_channel_status_update

    source

    Typed descriptor for VOICE_CHANNEL_STATUS_UPDATE — a voice channel's status text changed. Delivered under the GUILDS intent.

    Events::voice_server_update

    source

    Typed descriptor for VOICE_SERVER_UPDATE — voice server credentials for a pending voice connection (consumed internally by gaato/discord_voice's VoiceClient::join). Not gated by a gateway intent.

    Events::voice_state_update

    source

    Typed descriptor for VOICE_STATE_UPDATE — someone joined, left, or moved between voice channels, or a voice state changed (mute, deaf, ...). Delivered under the GUILD_VOICE_STATES intent.

    Events::webhooks_update

    source

    Typed descriptor for WEBHOOKS_UPDATE — a webhook in a channel was created, updated, or deleted. Delivered under the GUILD_WEBHOOKS intent.

    FetchedMembers

    source

    Members and optional presence/not-found fragments collected from all chunks.

    GatewayCtx

    source
    pub struct GatewayCtx {
      // private fields
    }

    Gateway-only services passed to event and service handlers after READY.

    GatewayCtx::app

    source

    The transport-neutral application context for REST access.

    GatewayCtx::cache

    source

    The cache attached with BotBuilder::attach_cache, or None when no cache is attached.

    GatewayCtx::channel_ref

    source

    Bind a channel id to the gateway REST client.

    GatewayCtx::expect_event

    source
    fn[T] GatewayCtx::expect_event(self : GatewayCtx, event_type : EventType[T], predicate : (T) -> Bool) -> PendingEvent[T]

    Expect the next gateway event of event_type that satisfies predicate. The expectation is registered now, so create it before sending the command that makes Discord dispatch the event, then wait for it. Like wait_for, the event stays visible to other collectors and registered handlers.

    GatewayCtx::fetch_guild_members

    source
    async fn GatewayCtx::fetch_guild_members(self : GatewayCtx, guild_id : 
    Id    [
    GuildMarker    ], select : 
    MemberSelect    , presences? : Bool, timeout_ms? : Int) -> FetchedMembers

    Fetch every matching member chunk with a process-unique nonce. Requires GUILD_MEMBERS for All and GUILD_PRESENCES when requesting presences. The deadline includes sending; raises GatewayRequestTimeout on timeout, GatewayRateLimited for a matching RATE_LIMITED response, and ShardNotManaged for a remote shard. All expectations are cancelled on exit.

    GatewayCtx::framework_raw

    source

    Access the underlying interaction framework.

    GatewayCtx::guild_ref

    source

    Bind a guild id to the gateway REST client.

    GatewayCtx::intents

    source

    The intents this bot identified with.

    GatewayCtx::latency_ms

    source
    fn GatewayCtx::latency_ms(self : GatewayCtx) -> Int64?

    The latest heartbeat round-trip time for this context's shard. Unlike AppCtx::latency_ms(), this is the exact shard value rather than the mean across shards with measured latency.

    GatewayCtx::member_ref

    source

    Bind a guild/user id pair to the gateway REST client.

    GatewayCtx::message_ref

    source

    Bind a message-create event's message to the gateway REST client.

    GatewayCtx::ready

    source

    The latest READY payload for this gateway session.

    GatewayCtx::ref_of_message

    source

    Bind a message model to the gateway REST client.

    GatewayCtx::request_channel_info

    source
    async fn GatewayCtx::request_channel_info(self : GatewayCtx, request : 
    RequestChannelInfo    ) -> Unit

    Route an ephemeral channel-info request; raises ShardNotManaged for remote shards.

    GatewayCtx::request_guild_members

    source
    async fn GatewayCtx::request_guild_members(self : GatewayCtx, request : 
    RequestGuildMembers    ) -> Unit

    Validate and route a member request; raises ShardNotManaged for remote shards.

    GatewayCtx::request_soundboard_sounds

    source
    async fn GatewayCtx::request_soundboard_sounds(self : GatewayCtx, request : 
    RequestSoundboardSounds    ) -> Unit

    Group guild ids by owning shard. Every owner is checked before any send; raises ShardNotManaged if any guild belongs to another process.

    GatewayCtx::resolve_channel

    source

    Resolve a channel with a cache-first lookup, including cached threads. Cache misses (including a disabled channels resource) fall back to REST. This favors speed; use channel_ref(id).fetch() when the latest channel state is required. A REST result is deliberately not written back because gateway events are the cache's only mutation entry point.

    MessageCreateEvent.channel_type is commonly absent, so resolving the channel makes thread detection straightforward:

    let channel = ctx.resolve_channel(event.message.channel_id)

    let is_thread = match channel.typ {
      AnnouncementThread | PublicThread | PrivateThread => true
      _ => false
    }

    GatewayCtx::shard_raw

    source

    Access the underlying gateway shard.

    GatewayCtx::shutdown

    source
    async fn GatewayCtx::shutdown(self : GatewayCtx) -> Unit

    Request a graceful stop. From the request on, no event middleware, event handler, or interaction handler starts: events still waiting for handlers are discarded (EventDiscarded telemetry), event handlers waiting for capacity are dropped, and interactions waiting for capacity are dropped with AppWarning::InteractionDroppedWhileStopping. Closing every managed shard wakes the run loop; run then waits for the handlers that had started, for at most the bot's shutdown_grace_ms, and cancels the ones still running after it.

    GatewayCtx::update_presence

    source
    async fn GatewayCtx::update_presence(self : GatewayCtx, presence : 
    UpdatePresence    ) -> Unit

    Broadcast presence to all locally managed shards. Shards in other processes are not reached. Attempts every local shard, then raises the first error.

    GatewayCtx::update_voice_state

    source
    async fn GatewayCtx::update_voice_state(self : GatewayCtx, state : 
    UpdateVoiceState    ) -> Unit

    Send opcode 4 (Update Voice State) on the shard that owns state.guild_id, which need not be this context's shard. Raises BotError::ShardNotManaged when that shard runs in another process.

    GatewayCtx::user_ref

    source

    Bind a user id to the gateway REST client.

    GatewayCtx::wait_for

    source
    async fn[T] GatewayCtx::wait_for(self : GatewayCtx, event_type : EventType[T], predicate : (T) -> Bool, timeout_ms? : Int) -> T?

    Wait for the next gateway event of event_type that satisfies predicate. The event remains visible to other collectors and registered handlers. Returns None on timeout. The caller must enable an intent capable of delivering the requested event when it is not already subscribed.

    GatewayCtx::wait_for_component

    source

    Wait for the next click on the component route.custom_id(state) identifies, optionally only from user. A gateway event has no invoking user, so unlike the interaction contexts' from filter this one defaults to anyone. Returns None on timeout; raises CustomIdError when the state does not encode. The returned context has not been answered and skips the automatic defer: respond to it within three seconds. For an id not built by a route, use framework_raw().wait_for_component(custom_id~).

    PendingEvent

    source
    pub struct PendingEvent[T] {
      // private fields
    }

    One expected gateway event, from GatewayCtx::expect_event. It is registered when created, separately from waiting, so a caller can install it before sending the command that makes Discord dispatch the event.

    PendingEvent::cancel

    source
    fn[T] PendingEvent::cancel(self : PendingEvent[T]) -> Unit

    Stop expecting the event. wait also cancels when it returns, so this is for an expectation that is abandoned without waiting.

    PendingEvent::wait

    source
    async fn[T] PendingEvent::wait(self : PendingEvent[T], timeout_ms? : Int) -> T?

    Wait for the expected event. Returns None on timeout. An event that arrived after the expectation was created and before this call is returned at once.

    ShardConfig

    source
    pub(all) enum ShardConfig {
      Auto
      Single(id~ : Int, count~ : Int)
      Fixed(count~ : Int)
      Range(ids~ : Array[Int], count~ : Int)
    } derive(
    Debug    )

    Selects which Gateway shards this process owns.

    DEFAULT_EVENT_BACKLOG

    source
    let DEFAULT_EVENT_BACKLOG : Int

    Gateway events that may wait for event handlers before later ones are dropped for handlers.

    DEFAULT_SHUTDOWN_GRACE_MS

    source
    let DEFAULT_SHUTDOWN_GRACE_MS : Int

    How long run waits after a requested shutdown for handlers that are still running before it cancels them.

    Source Files

    Powered by MoonBit

    Site sourceReport issuePackagesBuild queueSkillsStatistics

    © 2026 mooncakes.io