Enum BotEvent 

#[non_exhaustive]
pub enum BotEvent {
    Ready {
        communities: usize,
    },
    Message(IncomingMessage),
    MessageUpdate {
        chat_id: String,
        message: Message,
    },
    Delete {
        chat_id: String,
        message_id: String,
    },
    MemberJoin {
        channel_id: String,
        npub: String,
    },
    MemberLeave {
        channel_id: String,
        npub: String,
    },
    Typing {
        chat_id: String,
        npub: String,
        until: u64,
    },
    Invite {
        community_id: String,
    },
    Removed {
        community_id: String,
    },
    ChannelKeyed {
        community_id: String,
        channel_id: String,
        backfilled: usize,
    },
}

Every kind of inbound event a bot can observe. Delivered to VectorBot::on_event. DMs and Community channels are unified: chat_id is the sender’s npub for a DM, the channel id for a Community message.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ready

The realtime subscriptions REGISTERED: healthy relays deliver live events from this moment. Fires once per listen, right after the startup catch-up sync — stream auth continues in the background, and each AUTH-gating relay joins the stream the moment its own auth completes, gating nobody else. No longer gated on the slowest relay in the set. Fires even with communities: 0, so “subscribed to nothing” and “still connecting” are different observable states. Messages sent BEFORE this are not delivered live; recover them with a sync + Channel::history.

Fields

communities: usize

Message(IncomingMessage)

A new message (DM or Community channel).

MessageUpdate

A reaction or edit landed on an existing message; message is the updated view (inspect .reactions / .content, keyed by message.id).

Fields

chat_id: String

message: Message

Delete

A message was deleted (cooperative delete / moderation tombstone).

Fields

chat_id: String

message_id: String

MemberJoin

A member joined a Community channel.

Fields

channel_id: String

npub: String

MemberLeave

A member left (or was kicked from) a Community channel.

Fields

channel_id: String

npub: String

Typing

A member is typing in a Community channel; until is the unix-secs the indicator expires.

Fields

chat_id: String

npub: String

until: u64

Invite

A Community invite arrived. Already auto-handled per InvitePolicy; surfaced for visibility (and for Manual policy, so you can decide via VectorBot::accept_invite).

Fields

community_id: String

Removed

This bot was removed from a Community (kicked / banned / a leave authored on another device).

Fields

community_id: String

ChannelKeyed

A private channel became readable — its key arrived after an admin granted access. Until this fires, the channel is listed by Community::channels with is_readable() false.

backfilled counts the messages that PREDATE the grant and were pulled into local state before this event. They are history, not delivery — none of them arrive as BotEvent::Message, ever. Read them explicitly and decide what deserves acting on:

if backfilled > 0 {
    let missed = bot.community(community_id).channel(channel_id).history(backfilled).await;
    // e.g. answer the question that was asked before the grant
}

Fields

community_id: String

channel_id: String

backfilled: usize

Trait Implementations

impl Clone for BotEvent

fn clone(&self) -> BotEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BotEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.