IRCUser

An aggregate of fields representing a single user on IRC.

Instances of these should not survive a disconnect and reconnect; they are transient on a per-connection basis and should not be serialised.

final pure nothrow @nogc

struct IRCUser {

string nickname;

version(BotElements)

Class class_;

version(TwitchSupport)

string realName;

string ident;

string address;

string account;

long updated;

version(TwitchSupport)

string displayName;

version(TwitchSupport)

string badges;

version(TwitchSupport)

string colour;

this(string userstring);

this(string nickname, string ident, string address);

auto isServer();

auto opEquals(IRCUser that);

void toString(Sink sink);

string hostmask();

}

Constructors

this this(string userstring): Create a new IRCUser based on a *!*@* mask string.
this this(string nickname, string ident, string address): Create a new IRCUser inheriting passed nickname, ident, and address strings.

Members

Enums

Class enum Class: Classifiers; roles which a user is one of.

Functions

hostmask string hostmask(): Formats this IRCUser into a hostmask representing its values. Merely wraps toString and returns a newly allocated string.
isServer auto isServer(): Makes an educated guess that a sender is a server.
opEquals auto opEquals(IRCUser that): Compares two IRCUsers with each other, ignoring members considered to be extra or optional.
toHash auto toHash(): Produces a hash for this IRCUser.
toString void toString(Sink sink): Formats this IRCUser into a hostmask representing its values. Stores the result in the passed output range sink.

Variables

account string account;: Services account name (to NickServ, AuthServ, Q, etc).
address string address;: The reported user address, which may be a cloak.
badges string badges;: The Twitch badges this user has.
class_ Class class_;: User classifier.
colour string colour;: The Twitch colour (RRGGBB) to tint the user's nickname with.
displayName string displayName;: The alternate "display name" of the user.
id uint id;: The Twitch ID of this user's account.
ident string ident;: The user's IDENT identification.
nickname string nickname;: The user's nickname.
realName string realName;: The user's GECOS/"real name".
updated long updated;: Timestamp when the user was last modified.

dialect defs structs