Struct hexchat::UserMask

pub struct UserMask { /* fields omitted */ }

Represents a user mask, typically formatted like nick!user@address, where any of the components can be replaced with a *.

Methods

impl UserMask

pub fn new(mask: impl Into<String>) -> Option<Self>

Creates a new UserMask from a usermask string. Must be in nick!user@address form. Returns the newly created usermask, or None if mask was not formatted correctly.

pub fn as_str(&self) -> &str

Gets the usermask string.

pub fn into_string(self) -> String

Consumes this object and returns the inner usermask string.

pub fn get_nick(&self) -> Option<IrcIdentRef>

Gets the nick component of the usermask string, or None if wildcard.

pub fn get_username(&self) -> Option<IrcIdentRef>

Gets the username component of the usermask string, or None if wildcard.

pub fn get_host(&self) -> Option<&str>

Gets the host component of the address, or None if wildcard.

pub fn get_domain(&self) -> Option<&str>

Gets the domain component of the address, or None if wildcard.

Trait Implementations

impl Clone for UserMask

fn clone(&self) -> UserMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserMask

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

Formats the value using the given formatter.

impl Deref for UserMask

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for UserMask

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

Formats the value using the given formatter.

impl Eq for UserMask

impl From<UserString> for UserMask

fn from(mask: UserString) -> Self

Performs the conversion.

impl Hash for UserMask

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 Into<String> for UserMask

fn into(self) -> String

Performs the conversion.

impl Ord for UserMask

fn cmp(&self, other: &Self) -> 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<UserMask> for UserMask

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

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

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

This method tests for !=.

impl PartialOrd<UserMask> for UserMask

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for UserMask

impl StructuralPartialEq for UserMask

impl TryFrom<String> for UserMask

type Error = ()

The type returned in the event of a conversion error.

fn try_from(string: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<UserMask> for UserString

type Error = ()

The type returned in the event of a conversion error.

fn try_from(mask: UserMask) -> Result<Self, Self::Error>

Performs the conversion.