Struct hexavalent::list::IgnoreFlags

pub struct IgnoreFlags { /* fields omitted */ }

Flags related to ignore state.

Part of Ignore.

Implementations

impl IgnoreFlags

pub const PRIVATE: IgnoreFlags

Private messages are ignored.

pub const NOTICE: IgnoreFlags

Notice messages are ignored.

pub const CHANNEL: IgnoreFlags

Channel messages are ignored.

pub const CTCP: IgnoreFlags

CTCP commands are ignored.

pub const INVITE: IgnoreFlags

Invitations are ignored.

pub const UNIGNORE: IgnoreFlags

This is an "unignore" entry.

pub const NO_SAVE: IgnoreFlags

This ignore entry is temporary.

pub const DCC: IgnoreFlags

DCC transfers are ignored.

pub const fn empty() -> IgnoreFlags

Returns an empty set of flags

pub const fn all() -> IgnoreFlags

Returns the set containing all flags.

pub const fn bits(&self) -> i32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: i32) -> Option<IgnoreFlags>

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

pub const fn from_bits_truncate(bits: i32) -> IgnoreFlags

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

pub const unsafe fn from_bits_unchecked(bits: i32) -> IgnoreFlags

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: IgnoreFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for IgnoreFlags

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

Formats the value using the given formatter.

impl BitAnd<IgnoreFlags> for IgnoreFlags

type Output = IgnoreFlags

The resulting type after applying the & operator.

pub fn bitand(self, other: IgnoreFlags) -> IgnoreFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<IgnoreFlags> for IgnoreFlags

pub fn bitand_assign(&mut self, other: IgnoreFlags)

Disables all flags disabled in the set.

impl BitOr<IgnoreFlags> for IgnoreFlags

type Output = IgnoreFlags

The resulting type after applying the | operator.

pub fn bitor(self, other: IgnoreFlags) -> IgnoreFlags

Returns the union of the two sets of flags.

impl BitOrAssign<IgnoreFlags> for IgnoreFlags

pub fn bitor_assign(&mut self, other: IgnoreFlags)

Adds the set of flags.

impl BitXor<IgnoreFlags> for IgnoreFlags

type Output = IgnoreFlags

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: IgnoreFlags) -> IgnoreFlags

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

impl BitXorAssign<IgnoreFlags> for IgnoreFlags

pub fn bitxor_assign(&mut self, other: IgnoreFlags)

Toggles the set of flags.

impl Clone for IgnoreFlags

pub fn clone(&self) -> IgnoreFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for IgnoreFlags

impl Debug for IgnoreFlags

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

Formats the value using the given formatter.

impl Eq for IgnoreFlags

impl Extend<IgnoreFlags> for IgnoreFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<IgnoreFlags> for IgnoreFlags

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

Creates a value from an iterator.

impl Hash for IgnoreFlags

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

Feeds this value into the given Hasher.

pub 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 IgnoreFlags

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

Formats the value using the given formatter.

impl Not for IgnoreFlags

type Output = IgnoreFlags

The resulting type after applying the ! operator.

pub fn not(self) -> IgnoreFlags

Returns the complement of this set of flags.

impl Octal for IgnoreFlags

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

Formats the value using the given formatter.

impl Ord for IgnoreFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<IgnoreFlags> for IgnoreFlags

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

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

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

This method tests for !=.

impl PartialOrd<IgnoreFlags> for IgnoreFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for IgnoreFlags

impl StructuralPartialEq for IgnoreFlags

impl Sub<IgnoreFlags> for IgnoreFlags

type Output = IgnoreFlags

The resulting type after applying the - operator.

pub fn sub(self, other: IgnoreFlags) -> IgnoreFlags

Returns the set difference of the two sets of flags.

impl SubAssign<IgnoreFlags> for IgnoreFlags

pub fn sub_assign(&mut self, other: IgnoreFlags)

Disables all flags enabled in the set.

impl UpperHex for IgnoreFlags

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

Formats the value using the given formatter.