Enum tbot::types::bot_command::Scope

#[non_exhaustive]
pub enum Scope {
    Default,
    AllPrivateChats,
    AllGroupChats,
    AllChatAdministrators,
    Chat(ChatId),
    ChatAdministrators(ChatId),
    ChatMember(ChatId, Id),
}

A scope for which a list of bot commands is applied.

Represents BotCommandScope.

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.

Default

The default scope, used when no narrower scope is specified.

AllPrivateChats

A scope for all private chats.

AllGroupChats

A scope for all group chats.

AllChatAdministrators

A scope for administrators of all chats.

Chat(ChatId)

A scope for a particular chat.

ChatAdministrators(ChatId)

A scope for administrators of a particular chat.

ChatMember(ChatId, Id)

A scope for a particular member of a specific chat.

Implementations

impl Scope

pub fn is_default(&self) -> bool

Returns true if self is of variant Default.

pub fn is_all_private_chats(&self) -> bool

Returns true if self is of variant AllPrivateChats.

pub fn is_all_group_chats(&self) -> bool

Returns true if self is of variant AllGroupChats.

pub fn is_all_chat_administrators(&self) -> bool

Returns true if self is of variant AllChatAdministrators.

pub fn is_chat(&self) -> bool

Returns true if self is of variant Chat.

pub fn expect_chat(self) -> ChatIdwhere
    Self: Debug,

Unwraps the value, yielding the content of Chat.

Panics

Panics if the value is not Chat, with a panic message including the content of self.

pub fn chat(self) -> Option<ChatId>

Returns Some if self is of variant Chat, and None otherwise.

pub fn is_chat_administrators(&self) -> bool

Returns true if self is of variant ChatAdministrators.

pub fn expect_chat_administrators(self) -> ChatIdwhere
    Self: Debug,

Unwraps the value, yielding the content of ChatAdministrators.

Panics

Panics if the value is not ChatAdministrators, with a panic message including the content of self.

pub fn chat_administrators(self) -> Option<ChatId>

Returns Some if self is of variant ChatAdministrators, and None otherwise.

pub fn is_chat_member(&self) -> bool

Returns true if self is of variant ChatMember.

pub fn expect_chat_member(self) -> (ChatId, Id)where
    Self: Debug,

Unwraps the value, yielding the content of ChatMember.

Panics

Panics if the value is not ChatMember, with a panic message including the content of self.

pub fn chat_member(self) -> Option<(ChatId, Id)>

Returns Some if self is of variant ChatMember, and None otherwise.

impl Scope

pub const fn with_all_private_chats() -> Self

Constructs a scope for all private chats.

pub const fn with_all_group_chats() -> Self

Constructs a scope for all group chats.

pub const fn with_all_chat_administrators() -> Self

Construct a scope for administrators of all chats.

pub fn with_chat(chat_id: impl ImplicitChatId) -> Self

Constructs a scope for a particular chat.

pub fn with_chat_administrators(chat_id: impl ImplicitChatId) -> Self

Constructs a scope for administrators of a particular chat.

pub fn with_chat_member(chat_id: impl ImplicitChatId, user_id: Id) -> Self

Constructs a scope for a particular member of the given chat.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Scope

Returns the “default value” for a type.

impl Hash for Scope

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<Scope> for Scope

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Scope

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Scope

impl StructuralEq for Scope

impl StructuralPartialEq for Scope