Struct hexchat::ChannelFlags

pub struct ChannelFlags { /* fields omitted */ }

Various boolean flags about a ChannelInfo.

Methods

impl ChannelFlags

pub const CONNECTED: ChannelFlags

Whether or not the client is currently connected.

pub const CONNECTING: ChannelFlags

Whether or not the client is currrently connecting.

pub const AWAY: ChannelFlags

Whether or not the client is currently away.

pub const MOTD_END: ChannelFlags

Whether or not the MOTD has ended yet.

pub const WHOX: ChannelFlags

Whether the server supports the WHOX protocol.

pub const IDMSG: ChannelFlags

Whether the server supports the IDMSG protocol.

pub const HIDE_JOINS_AND_PARTS: ChannelFlags

Whether the channel is hiding join/part messages.

pub const HIDE_JOINS_AND_PARTS_UNSET: ChannelFlags

Whether the channel is using the global default on whether to hide join/part messages.

pub const BEEP_ON_MESSAGE: ChannelFlags

Whether the channel is set to beep when a message is received.

pub const BLINK_TRAY: ChannelFlags

Whether the channel is currently blinking the tray.

pub const BLINK_TASKBAR: ChannelFlags

Whether the channel is currently blinking the taskbar.

pub const LOGGING: ChannelFlags

Whether the channel is logging messages.

pub const LOGGING_UNSET: ChannelFlags

Whether the channel is using the global default on whether to log messages.

pub const SCROLLBACK: ChannelFlags

Whether the channel allows for scrollback.

pub const SCROLLBACK_UNSET: ChannelFlags

Whether the channel is using the global default on whether to allow for scrollback.

pub const STRIP_COLORS: ChannelFlags

Whether the channel is stripping all colors.

pub const STRIP_COLORS_UNSET: ChannelFlags

Whether the channel is using the global default on whether to strip colors.

pub const fn empty() -> ChannelFlags

Returns an empty set of flags

pub const fn all() -> ChannelFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ChannelFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> ChannelFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ChannelFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ChannelFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ChannelFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ChannelFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ChannelFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ChannelFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ChannelFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ChannelFlags

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

Formats the value using the given formatter.

impl BitAnd<ChannelFlags> for ChannelFlags

type Output = ChannelFlags

The resulting type after applying the & operator.

fn bitand(self, other: ChannelFlags) -> ChannelFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<ChannelFlags> for ChannelFlags

fn bitand_assign(&mut self, other: ChannelFlags)

Disables all flags disabled in the set.

impl BitOr<ChannelFlags> for ChannelFlags

type Output = ChannelFlags

The resulting type after applying the | operator.

fn bitor(self, other: ChannelFlags) -> ChannelFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ChannelFlags> for ChannelFlags

fn bitor_assign(&mut self, other: ChannelFlags)

Adds the set of flags.

impl BitXor<ChannelFlags> for ChannelFlags

type Output = ChannelFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: ChannelFlags) -> ChannelFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ChannelFlags> for ChannelFlags

fn bitxor_assign(&mut self, other: ChannelFlags)

Toggles the set of flags.

impl Clone for ChannelFlags

fn clone(&self) -> ChannelFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelFlags

impl Debug for ChannelFlags

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

Formats the value using the given formatter.

impl Eq for ChannelFlags

impl Extend<ChannelFlags> for ChannelFlags

fn extend<T: IntoIterator<Item = ChannelFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<ChannelFlags> for ChannelFlags

fn from_iter<T: IntoIterator<Item = ChannelFlags>>(iterator: T) -> ChannelFlags

Creates a value from an iterator.

impl Hash for ChannelFlags

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for ChannelFlags

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

Formats the value using the given formatter.

impl Not for ChannelFlags

type Output = ChannelFlags

The resulting type after applying the ! operator.

fn not(self) -> ChannelFlags

Returns the complement of this set of flags.

impl Octal for ChannelFlags

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

Formats the value using the given formatter.

impl Ord for ChannelFlags

fn cmp(&self, other: &ChannelFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ChannelFlags> for ChannelFlags

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

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

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

This method tests for !=.

impl PartialOrd<ChannelFlags> for ChannelFlags

fn partial_cmp(&self, other: &ChannelFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ChannelFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ChannelFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ChannelFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ChannelFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ChannelFlags

impl StructuralPartialEq for ChannelFlags

impl Sub<ChannelFlags> for ChannelFlags

type Output = ChannelFlags

The resulting type after applying the - operator.

fn sub(self, other: ChannelFlags) -> ChannelFlags

Returns the set difference of the two sets of flags.

impl SubAssign<ChannelFlags> for ChannelFlags

fn sub_assign(&mut self, other: ChannelFlags)

Disables all flags enabled in the set.

impl UpperHex for ChannelFlags

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

Formats the value using the given formatter.