Struct ModeTypes

pub struct ModeTypes(/* private fields */);

A map of the non-status modes to their ModeTypes.

This type explicitly excludes status modes.

Implementations

impl ModeTypes

pub const fn new() -> Self

Returns a new, empty ModeTypes.

pub fn from_set(set: ModeSet, mode_type: ModeType) -> Self

Returns a ModeTypes constructed from one set of modes of a given ModeType.

pub fn from_sets( a: ModeSet, b: ModeSet, c: ModeSet, d: ModeSet, ) -> (Self, ModeSet)

Returns a ModeTypes constructed from the provided sets.

To ensure coherence, any overlaps between sets are removed and returned as a separate set. Use insert_set() to add them back.

pub fn parse(bytes: &[u8]) -> (Self, ModeSet, &[u8])

Parses a string as if it’s the value of a CHANMODES ISUPPORT token.

This function is deliberately permissive to support mode strings with modes that are not valid Modes.

In addition to Self, returns the rest of the mode string if there are additional mode types beyond what this type supports. It also returns any overlapping modes as from_sets.

pub fn get(&self, mode: Mode) -> Option<ModeType>

Returns the ModeType the provided mode, if known.

pub fn insert(&mut self, mode: Mode, mode_type: ModeType)

Sets the provided Mode’s ModeType.

pub fn insert_set(&mut self, mode_set: ModeSet, mode_type: ModeType)

Sets the ModeType for all the modes in the provided ModeSet.

Trait Implementations

impl Clone for ModeTypes

fn clone(&self) -> ModeTypes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModeTypes

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

Formats the value using the given formatter.

impl Default for ModeTypes

fn default() -> ModeTypes

Returns the “default value” for a type.

impl Display for ModeTypes

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

Formats the value using the given formatter.

impl Hash for ModeTypes

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ModeTypes

impl Eq for ModeTypes

impl StructuralPartialEq for ModeTypes