Struct twilight_model::channel::message::MessageFlags
source · pub struct MessageFlags { /* private fields */ }
Expand description
Flags to signal state and modify the look of a message.
Implementations§
source§impl MessageFlags
impl MessageFlags
sourcepub const CROSSPOSTED: Self = _
pub const CROSSPOSTED: Self = _
Has been published to subscribed channels via Channel Following.
sourcepub const IS_CROSSPOST: Self = _
pub const IS_CROSSPOST: Self = _
Is a crosspost from another channel via Channel Following.
sourcepub const SUPPRESS_EMBEDS: Self = _
pub const SUPPRESS_EMBEDS: Self = _
Do not include any embeds when serializing this message.
sourcepub const SOURCE_MESSAGE_DELETED: Self = _
pub const SOURCE_MESSAGE_DELETED: Self = _
Source message for this message has been deleted via Channel Following.
sourcepub const HAS_THREAD: Self = _
pub const HAS_THREAD: Self = _
A thread has been started from this message.
sourcepub const EPHEMERAL: Self = _
pub const EPHEMERAL: Self = _
When used, only shows a message to the invoking user.
Used when responding to an Interaction
.
sourcepub const LOADING: Self = _
pub const LOADING: Self = _
This message is an Interaction Response, and the bot is “thinking”.
sourcepub const FAILED_TO_MENTION_SOME_ROLES_IN_THREAD: Self = _
pub const FAILED_TO_MENTION_SOME_ROLES_IN_THREAD: Self = _
This message failed to mention some roles in a thread, which subsequently failed to add the role’s members to the thread.
sourcepub const SUPPRESS_NOTIFICATIONS: Self = _
pub const SUPPRESS_NOTIFICATIONS: Self = _
This message will not trigger push and desktop notifications.
sourcepub const IS_VOICE_MESSAGE: Self = _
pub const IS_VOICE_MESSAGE: Self = _
This message is a voice message.
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> Self
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: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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: Self) -> Self
pub const fn union(self, other: Self) -> Self
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: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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) -> Self
pub const fn complement(self) -> Self
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 MessageFlags
impl Binary for MessageFlags
source§impl BitAnd<MessageFlags> for MessageFlags
impl BitAnd<MessageFlags> for MessageFlags
source§impl BitAndAssign<MessageFlags> for MessageFlags
impl BitAndAssign<MessageFlags> for MessageFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<MessageFlags> for MessageFlags
impl BitOr<MessageFlags> for MessageFlags
source§fn bitor(self, other: MessageFlags) -> Self
fn bitor(self, other: MessageFlags) -> Self
Returns the union of the two sets of flags.
§type Output = MessageFlags
type Output = MessageFlags
|
operator.source§impl BitOrAssign<MessageFlags> for MessageFlags
impl BitOrAssign<MessageFlags> for MessageFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<MessageFlags> for MessageFlags
impl BitXor<MessageFlags> for MessageFlags
source§impl BitXorAssign<MessageFlags> for MessageFlags
impl BitXorAssign<MessageFlags> for MessageFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for MessageFlags
impl Clone for MessageFlags
source§fn clone(&self) -> MessageFlags
fn clone(&self) -> MessageFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MessageFlags
impl Debug for MessageFlags
source§impl<'de> Deserialize<'de> for MessageFlags
impl<'de> Deserialize<'de> for MessageFlags
source§fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
source§impl Extend<MessageFlags> for MessageFlags
impl Extend<MessageFlags> for MessageFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<MessageFlags> for MessageFlags
impl FromIterator<MessageFlags> for MessageFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for MessageFlags
impl Hash for MessageFlags
source§impl LowerHex for MessageFlags
impl LowerHex for MessageFlags
source§impl Not for MessageFlags
impl Not for MessageFlags
source§impl Octal for MessageFlags
impl Octal for MessageFlags
source§impl Ord for MessageFlags
impl Ord for MessageFlags
source§fn cmp(&self, other: &MessageFlags) -> Ordering
fn cmp(&self, other: &MessageFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq<MessageFlags> for MessageFlags
impl PartialEq<MessageFlags> for MessageFlags
source§fn eq(&self, other: &MessageFlags) -> bool
fn eq(&self, other: &MessageFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<MessageFlags> for MessageFlags
impl PartialOrd<MessageFlags> for MessageFlags
source§fn partial_cmp(&self, other: &MessageFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &MessageFlags) -> 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 MessageFlags
impl Serialize for MessageFlags
source§impl Sub<MessageFlags> for MessageFlags
impl Sub<MessageFlags> for MessageFlags
source§impl SubAssign<MessageFlags> for MessageFlags
impl SubAssign<MessageFlags> for MessageFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.