Struct hexchat::UserString

pub struct UserString { /* fields omitted */ }

Represents a userstring, typically formatted like nick!user@address.

Methods

impl UserString

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

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

pub fn from_parts(nick: &str, username: &str, address: &str) -> Option<Self>

Creates a UserString from the nick, username, and address components. Returns the new userstring, or None if address was incorrectly formatted.

pub fn as_str(&self) -> &str

Gets the userstring.

pub fn into_string(self) -> String

Consumes this object and returns the inner userstring.

pub fn get_nick(&self) -> IrcIdentRef

Gets the nick component of the userstring.

pub fn get_username(&self) -> IrcIdentRef

Gets the username component of the userstring.

pub fn get_address(&self) -> &str

Gets the address component of the userstring.

pub fn get_host(&self) -> &str

Gets the host component of the address.

pub fn get_domain(&self) -> &str

Gets the domain component of the address.

Trait Implementations

impl Clone for UserString

fn clone(&self) -> UserString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserString

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

Formats the value using the given formatter.

impl Deref for UserString

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Display for UserString

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

Formats the value using the given formatter.

impl Eq for UserString

impl From<UserString> for UserMask

fn from(mask: UserString) -> Self

Performs the conversion.

impl Hash for UserString

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 UserString

fn into(self) -> String

Performs the conversion.

impl Ord for UserString

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

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

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

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

This method tests for !=.

impl PartialOrd<UserString> for UserString

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 UserString

impl StructuralPartialEq for UserString

impl TryFrom<String> for UserString

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.