Struct teloxide::types::ChatPermissions
source · pub struct ChatPermissions { /* private fields */ }
Expand description
Describes actions that a non-administrator user is allowed to take in a chat.
Examples
use teloxide_core::types::ChatPermissions;
// No permissions, nothing is allowed
let _ = ChatPermissions::empty();
// All permissions, everything is allowed
let _ = ChatPermissions::all();
// One particular permission
let permissions_v0 = ChatPermissions::INVITE_USERS;
// Check what is permitted
assert!(permissions_v0.contains(ChatPermissions::INVITE_USERS));
assert!(!permissions_v0.contains(ChatPermissions::SEND_MESSAGES));
// Union, add permissions
let permissions_v1 = permissions_v0 | ChatPermissions::SEND_MEDIA_MESSAGES;
assert!(permissions_v1.contains(ChatPermissions::INVITE_USERS));
assert!(permissions_v1.contains(ChatPermissions::SEND_MEDIA_MESSAGES));
// Implied by `SEND_MEDIA_MESSAGES`
assert!(permissions_v1.contains(ChatPermissions::SEND_MESSAGES));
// Difference, remove permissions
let permissions_v2 = permissions_v1 - ChatPermissions::SEND_MEDIA_MESSAGES;
assert!(!permissions_v2.contains(ChatPermissions::SEND_MEDIA_MESSAGES));
// Removing `SEND_MEDIA_MESSAGES` also removes `SEND_MESSAGES` and vice versa
// because `SEND_MESSAGES` is implied by `SEND_MEDIA_MESSAGES`
assert!(!permissions_v2.contains(ChatPermissions::SEND_MESSAGES));
let permissions_v3 = permissions_v1 - ChatPermissions::SEND_MESSAGES;
assert!(!permissions_v3.contains(ChatPermissions::SEND_MEDIA_MESSAGES));
Implementations§
source§impl ChatPermissions
impl ChatPermissions
sourcepub const SEND_MESSAGES: ChatPermissions = Self{ bits: 1,}
pub const SEND_MESSAGES: ChatPermissions = Self{ bits: 1,}
Set if the user is allowed to send text messages, contacts, locations and venues.
sourcepub const SEND_MEDIA_MESSAGES: ChatPermissions = Self{ bits: 1 << 1 | Self::SEND_MESSAGES.bits,}
pub const SEND_MEDIA_MESSAGES: ChatPermissions = Self{ bits: 1 << 1 | Self::SEND_MESSAGES.bits,}
Set if the user is allowed to send audios, documents,
photos, videos, video notes and voice notes, implies
SEND_MESSAGES
.
sourcepub const SEND_POLLS: ChatPermissions = Self{ bits: 1 << 2 | Self::SEND_MESSAGES.bits,}
pub const SEND_POLLS: ChatPermissions = Self{ bits: 1 << 2 | Self::SEND_MESSAGES.bits,}
Set if the user is allowed to send polls, implies
SEND_MESSAGES
.
sourcepub const SEND_OTHER_MESSAGES: ChatPermissions = Self{ bits: 1 << 3 | Self::SEND_MEDIA_MESSAGES.bits,}
pub const SEND_OTHER_MESSAGES: ChatPermissions = Self{ bits: 1 << 3 | Self::SEND_MEDIA_MESSAGES.bits,}
Set if the user is allowed to send animations, games, stickers and
use inline bots, implies SEND_MEDIA_MESSAGES
.
sourcepub const ADD_WEB_PAGE_PREVIEWS: ChatPermissions = Self{ bits: 1 << 4 | Self::SEND_MEDIA_MESSAGES.bits,}
pub const ADD_WEB_PAGE_PREVIEWS: ChatPermissions = Self{ bits: 1 << 4 | Self::SEND_MEDIA_MESSAGES.bits,}
Set if the user is allowed to add web page previews to
their messages, implies SEND_MEDIA_MESSAGES
.
sourcepub const CHANGE_INFO: ChatPermissions = Self{ bits: 1 << 5,}
pub const CHANGE_INFO: ChatPermissions = Self{ bits: 1 << 5,}
Set if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.
sourcepub const INVITE_USERS: ChatPermissions = Self{ bits: 1 << 6,}
pub const INVITE_USERS: ChatPermissions = Self{ bits: 1 << 6,}
Set if the user is allowed to invite new users to the chat.
sourcepub const PIN_MESSAGES: ChatPermissions = Self{ bits: 1 << 7,}
pub const PIN_MESSAGES: ChatPermissions = Self{ bits: 1 << 7,}
Set if the user is allowed to pin messages. Ignored in public supergroups.
sourcepub const MANAGE_TOPICS: ChatPermissions = Self{ bits: 1 << 8,}
pub const MANAGE_TOPICS: ChatPermissions = Self{ bits: 1 << 8,}
Set if the user is allowed to create, rename, close, and reopen forum topics.
sourcepub const fn empty() -> ChatPermissions
pub const fn empty() -> ChatPermissions
Returns an empty set of flags.
sourcepub const fn all() -> ChatPermissions
pub const fn all() -> ChatPermissions
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u16) -> Option<ChatPermissions>
pub const fn from_bits(bits: u16) -> Option<ChatPermissions>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u16) -> ChatPermissions
pub const fn from_bits_truncate(bits: u16) -> ChatPermissions
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> ChatPermissions
pub const unsafe fn from_bits_unchecked(bits: u16) -> ChatPermissions
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: ChatPermissions) -> bool
pub const fn intersects(&self, other: ChatPermissions) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ChatPermissions) -> bool
pub const fn contains(&self, other: ChatPermissions) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ChatPermissions)
pub fn insert(&mut self, other: ChatPermissions)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ChatPermissions)
pub fn remove(&mut self, other: ChatPermissions)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ChatPermissions)
pub fn toggle(&mut self, other: ChatPermissions)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ChatPermissions, value: bool)
pub fn set(&mut self, other: ChatPermissions, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: ChatPermissions) -> ChatPermissions
pub const fn intersection(self, other: ChatPermissions) -> ChatPermissions
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: ChatPermissions) -> ChatPermissions
pub const fn union(self, other: ChatPermissions) -> ChatPermissions
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: ChatPermissions) -> ChatPermissions
pub const fn difference(self, other: ChatPermissions) -> ChatPermissions
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(
self,
other: ChatPermissions
) -> ChatPermissions
pub const fn symmetric_difference(
self,
other: ChatPermissions
) -> ChatPermissions
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> ChatPermissions
pub const fn complement(self) -> ChatPermissions
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl Binary for ChatPermissions
impl Binary for ChatPermissions
source§impl BitAnd<ChatPermissions> for ChatPermissions
impl BitAnd<ChatPermissions> for ChatPermissions
source§fn bitand(self, other: ChatPermissions) -> ChatPermissions
fn bitand(self, other: ChatPermissions) -> ChatPermissions
Returns the intersection between the two sets of flags.
§type Output = ChatPermissions
type Output = ChatPermissions
&
operator.source§impl BitAndAssign<ChatPermissions> for ChatPermissions
impl BitAndAssign<ChatPermissions> for ChatPermissions
source§fn bitand_assign(&mut self, other: ChatPermissions)
fn bitand_assign(&mut self, other: ChatPermissions)
Disables all flags disabled in the set.
source§impl BitOr<ChatPermissions> for ChatPermissions
impl BitOr<ChatPermissions> for ChatPermissions
source§fn bitor(self, other: ChatPermissions) -> ChatPermissions
fn bitor(self, other: ChatPermissions) -> ChatPermissions
Returns the union of the two sets of flags.
§type Output = ChatPermissions
type Output = ChatPermissions
|
operator.source§impl BitOrAssign<ChatPermissions> for ChatPermissions
impl BitOrAssign<ChatPermissions> for ChatPermissions
source§fn bitor_assign(&mut self, other: ChatPermissions)
fn bitor_assign(&mut self, other: ChatPermissions)
Adds the set of flags.
source§impl BitXor<ChatPermissions> for ChatPermissions
impl BitXor<ChatPermissions> for ChatPermissions
source§fn bitxor(self, other: ChatPermissions) -> ChatPermissions
fn bitxor(self, other: ChatPermissions) -> ChatPermissions
Returns the left flags, but with all the right flags toggled.
§type Output = ChatPermissions
type Output = ChatPermissions
^
operator.source§impl BitXorAssign<ChatPermissions> for ChatPermissions
impl BitXorAssign<ChatPermissions> for ChatPermissions
source§fn bitxor_assign(&mut self, other: ChatPermissions)
fn bitxor_assign(&mut self, other: ChatPermissions)
Toggles the set of flags.
source§impl Clone for ChatPermissions
impl Clone for ChatPermissions
source§fn clone(&self) -> ChatPermissions
fn clone(&self) -> ChatPermissions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ChatPermissions
impl Debug for ChatPermissions
source§impl<'de> Deserialize<'de> for ChatPermissions
impl<'de> Deserialize<'de> for ChatPermissions
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<ChatPermissions, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<ChatPermissions, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
source§impl Extend<ChatPermissions> for ChatPermissions
impl Extend<ChatPermissions> for ChatPermissions
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ChatPermissions>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ChatPermissions>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl From<ChatPermissionsRaw> for ChatPermissions
impl From<ChatPermissionsRaw> for ChatPermissions
source§fn from(_: ChatPermissionsRaw) -> ChatPermissions
fn from(_: ChatPermissionsRaw) -> ChatPermissions
source§impl FromIterator<ChatPermissions> for ChatPermissions
impl FromIterator<ChatPermissions> for ChatPermissions
source§fn from_iter<T>(iterator: T) -> ChatPermissionswhere
T: IntoIterator<Item = ChatPermissions>,
fn from_iter<T>(iterator: T) -> ChatPermissionswhere
T: IntoIterator<Item = ChatPermissions>,
source§impl Hash for ChatPermissions
impl Hash for ChatPermissions
source§impl LowerHex for ChatPermissions
impl LowerHex for ChatPermissions
source§impl Not for ChatPermissions
impl Not for ChatPermissions
source§fn not(self) -> ChatPermissions
fn not(self) -> ChatPermissions
Returns the complement of this set of flags.
§type Output = ChatPermissions
type Output = ChatPermissions
!
operator.source§impl Octal for ChatPermissions
impl Octal for ChatPermissions
source§impl Ord for ChatPermissions
impl Ord for ChatPermissions
source§fn cmp(&self, other: &ChatPermissions) -> Ordering
fn cmp(&self, other: &ChatPermissions) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<ChatPermissions> for ChatPermissions
impl PartialEq<ChatPermissions> for ChatPermissions
source§fn eq(&self, other: &ChatPermissions) -> bool
fn eq(&self, other: &ChatPermissions) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ChatPermissions> for ChatPermissions
impl PartialOrd<ChatPermissions> for ChatPermissions
source§fn partial_cmp(&self, other: &ChatPermissions) -> Option<Ordering>
fn partial_cmp(&self, other: &ChatPermissions) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for ChatPermissions
impl Serialize for ChatPermissions
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
source§impl Sub<ChatPermissions> for ChatPermissions
impl Sub<ChatPermissions> for ChatPermissions
source§fn sub(self, other: ChatPermissions) -> ChatPermissions
fn sub(self, other: ChatPermissions) -> ChatPermissions
Returns the set difference of the two sets of flags.
§type Output = ChatPermissions
type Output = ChatPermissions
-
operator.source§impl SubAssign<ChatPermissions> for ChatPermissions
impl SubAssign<ChatPermissions> for ChatPermissions
source§fn sub_assign(&mut self, other: ChatPermissions)
fn sub_assign(&mut self, other: ChatPermissions)
Disables all flags enabled in the set.
source§impl UpperHex for ChatPermissions
impl UpperHex for ChatPermissions
impl Copy for ChatPermissions
impl Eq for ChatPermissions
impl StructuralEq for ChatPermissions
impl StructuralPartialEq for ChatPermissions
Auto Trait Implementations§
impl RefUnwindSafe for ChatPermissions
impl Send for ChatPermissions
impl Sync for ChatPermissions
impl Unpin for ChatPermissions
impl UnwindSafe for ChatPermissions
Blanket Implementations§
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.