Enum NotifyTo 

#[non_exhaustive]
pub enum NotifyTo {
    Room(ConversationKey),
    User(ChannelId, UserId),
    Person(String),
    Admins,
}

One destination of a [[notify]] target, written as text in okbot.toml.

Text	Meaning
room:<conversation>	a room, chat, space or thread, as /whoami shows it
user:<platform>:<instance>/<user id>	that account’s direct chat
person:<id>	one direct chat of a person from [people] (owner on a personal bot)
admins	the direct chat of every [bot] admins account (and the owner’s)

A room is the exact ConversationKey text, so threads and workspaces work on every platform without a platform-specific address format.

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.

Room(ConversationKey)

A conversation the bot posts into.

User(ChannelId, UserId)

One account’s direct chat.

Person(String)

A linked person’s direct chat on one of their platforms.

Admins

Every administrator’s direct chat.

Implementations

impl NotifyTo

pub fn room_address(key: &ConversationKey) -> String

The text that addresses the conversation key (room:<key>).

Trait Implementations

impl Clone for NotifyTo

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotifyTo

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

Formats the value using the given formatter.

impl Display for NotifyTo

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

Formats the value using the given formatter.

impl Eq for NotifyTo

impl FromStr for NotifyTo

type Err = IdError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NotifyTo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NotifyTo

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NotifyTo