1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
//! Enumeration of all the possible server responses.
#![allow(non_camel_case_types)]
use std::str::FromStr;
macro_rules! make_response {
($(#[$attr:meta] $variant:ident = $value:expr),+) => {
/// List of all server responses as defined in
/// [RFC 2812](http://tools.ietf.org/html/rfc2812).
/// All commands are documented with their expected form from the RFC.
#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(u16)]
pub enum Response {
$(#[$attr] $variant = $value),+
}
impl Response {
/// Generates a Response from a u16.
fn from_u16(val: u16) -> Option<Response> {
match val {
$($value => Some(Response::$variant),)+
_ => None
}
}
}
}
}
make_response! {
// Expected replies
/// `001 Welcome to the Internet Relay Network <nick>!<user>@<host>`
RPL_WELCOME = 1,
/// `002 Your host is <servername>, running version <ver>`
RPL_YOURHOST = 2,
/// `003 This server was created <date>`
RPL_CREATED = 3,
/// `004 <servername> <version> <available user modes> available channel modes>`
RPL_MYINFO = 4,
/// `005 <servername> *(<feature>(=<value>)) :are supported by this server`
RPL_ISUPPORT = 5,
/// `010 Try server <server name>, port <port number>`
RPL_BOUNCE = 10,
/// `302 :*1<reply> *( " " <reply> )`
RPL_USERHOST = 302,
/// `303 :*1<nick> *( " " <nick> )`
RPL_ISON = 303,
/// `301 <nick> :<away message>`
RPL_AWAY = 301,
/// `305 :You are no longer marked as being away`
RPL_UNAWAY = 305,
/// `306 :You have been marked as being away`
RPL_NOWAWAY = 306,
/// `311 <nick> <user> <host> * :<real name>`
RPL_WHOISUSER = 311,
/// `312 <nick> <server> :<server info>`
RPL_WHOISSERVER = 312,
/// `313 <nick> :is an IRC operator`
RPL_WHOISOPERATOR = 313,
/// `317 <nick> <integer> :seconds idle`
RPL_WHOISIDLE = 317,
/// `318 <nick> :End of WHOIS list`
RPL_ENDOFWHOIS = 318,
/// `319 <nick> :*( ( "@" / "+" ) <channel> " " )`
RPL_WHOISCHANNELS = 319,
/// `314 <nick> <user> <host> * :<real name>`
RPL_WHOWASUSER = 314,
/// `369 <nick> :End of WHOWAS`
RPL_ENDOFWHOWAS = 369,
/// Obsolete. Not used.
RPL_LISTSTART = 321,
/// `322 <channel> <# visible> :<topic>`
RPL_LIST = 322,
/// `323 :End of LIST
RPL_LISTEND = 323,
/// `325 <channel> <nickname>`
RPL_UNIQOPIS = 325,
/// `324 <channel> <mode> <mode params>`
RPL_CHANNELMODEIS = 324,
/// `331 <channel> :No topic is set`
RPL_NOTOPIC = 331,
/// `332 <channel> :<topic>`
RPL_TOPIC = 332,
/// `333 <channel> <nick>!<user>@<host> <unix timestamp>`
RPL_TOPICWHOTIME = 333,
/// `341 <channel> <nick>`
RPL_INVITING = 341,
/// `342 <user> :Summoning user to IRC`
RPL_SUMMONING = 342,
/// `346 <channel> <invitemask>`
RPL_INVITELIST = 346,
/// `347 <channel> :End of channel invite list`
RPL_ENDOFINVITELIST = 347,
/// `348 <channel> <exceptionmask>`
RPL_EXCEPTLIST = 348,
/// `349 <channel> :End of channel exception list`
RPL_ENDOFEXCEPTLIST = 349,
/// `351 <version>.<debuglevel> <server> :<comments>`
RPL_VERSION = 351,
/** `352 <channel> <user> <host> <server> <nick> ( "H" / "G" > ["*"] [ ( "@" / "+" ) ]
:<hopcount> <real name>` **/
RPL_WHOREPLY = 352,
/// `315 <name> :End of WHO list`
RPL_ENDOFWHO = 315,
/// `353 ( "=" / "*" / "@" ) <channel> :[ "@" / "+" ] <nick> *( " " [ "@" / "+" ] <nick> )`
RPL_NAMREPLY = 353,
/// `366 <channel> :End of NAMES list`
RPL_ENDOFNAMES = 366,
/// `364 <mask> <server> :<hopcount> <server info>`
RPL_LINKS = 364,
/// `365 <mask> :End of LINKS list`
RPL_ENDOFLINKS = 365,
/// `367 <channel> <banmask>`
RPL_BANLIST = 367,
/// `368 <channel> :End of channel ban list`
RPL_ENDOFBANLIST = 368,
/// `371 :<string>`
RPL_INFO = 371,
/// `374 :End of INFO list`
RPL_ENDOFINFO = 374,
/// `375 :- <server> Message of the day -`
RPL_MOTDSTART = 375,
/// `372 :- <text>`
RPL_MOTD = 372,
/// `376 :End of MOTD command`
RPL_ENDOFMOTD = 376,
/// `381 :You are now an IRC operator`
RPL_YOUREOPER = 381,
/// `382 <config file> :Rehashing`
RPL_REHASHING = 382,
/// `383 You are service <servicename>`
RPL_YOURESERVICE = 383,
/// `391 <server> :<string showing server's local time>`
RPL_TIME = 391,
/// `392 :UserID Terminal Host`
RPL_USERSSTART = 392,
/// `393 :<username> <ttyline> <hostname>`
RPL_USERS = 393,
/// `394 :End of users`
RPL_ENDOFUSERS = 394,
/// `395 :Nobody logged in`
RPL_NOUSERS = 395,
/** `200 Link <version & debug level> <destination> <next server> V<protocol version>
<link uptime in seconds> <backstream sendq> <upstream sendq>` **/
RPL_TRACELINK = 200,
/// `201 Try. <class> <server>`
RPL_TRACECONNECTING = 201,
/// `202 H.S. <class> <server>`
RPL_TRACEHANDSHAKE = 202,
/// `203 ???? <class> [<client IP address in dot form>]`
RPL_TRACEUKNOWN = 203,
/// `204 Oper <class> <nick>`
RPL_TRACEOPERATOR = 204,
/// `205 User <class> <nick>`
RPL_TRACEUSER = 205,
/// `206 Serv <class> <int>S <int>C <server> <nick!user|*!*>@<host|server> V<protocol version>`
RPL_TRACESERVER = 206,
/// `207 Service <class> <name> <type> <active type>`
RPL_TRACESERVICE = 207,
/// `208 <newtype> 0 <client name>`
RPL_TRACENEWTYPE = 208,
/// `209 Class <class> <count>`
RPL_TRACECLASS = 209,
/// Unused.
RPL_TRACERECONNECT = 210,
/// `261 File <logfile> <debug level>`
RPL_TRACELOG = 261,
/// `262 <server name> <version & debug level> :End of TRACE`
RPL_TRACEEND = 262,
/** `211 <linkname> <sendq> <sent messages> <sent Kbytes> <received messages> <received Kbytes>
<time open>` **/
RPL_STATSLINKINFO = 211,
/// `212 <command> <count> <byte count> <remote count>`
RPL_STATSCOMMANDS = 212,
/// `219 <stats letter> :End of STATS report`
RPL_ENDOFSTATS = 219,
/// `242 :Server Up %d days %d:%02d:%02d`
RPL_STATSUPTIME = 242,
/// `243 O <hostmask> * <name>`
RPL_STATSOLINE = 243,
/// `221 <user mode string>`
RPL_UMODEIS = 221,
/// `234 <name> <server> <mask> <type> <hopcount> <info>`
RPL_SERVLIST = 234,
/// `235 <mask> <type> :End of service listing`
RPL_SERVLISTEND = 235,
/// `251 :There are <integer> users and <integer> services on <integer> servers`
RPL_LUSERCLIENT = 251,
/// `252 <integer> :operator(s) online`
RPL_LUSEROP = 252,
/// `253 <integer> :unknown connection(s)`
RPL_LUSERUNKNOWN = 253,
/// `254 <integer> :channels formed`
RPL_LUSERCHANNELS = 254,
/// `255 :I have <integer> clients and <integer> servers`
RPL_LUSERME = 255,
/// `256 <server> :Administrative info`
RPL_ADMINME = 256,
/// `257 :<admin info>`
RPL_ADMINLOC1 = 257,
/// `258 :<admin info>`
RPL_ADMINLOC2 = 258,
/// `259 :<admin info>`
RPL_ADMINEMAIL = 259,
/// `263 <command> :Please wait a while and try again.`
RPL_TRYAGAIN = 263,
/// `730 <nick> :target[,target2]*`
RPL_MONONLINE = 730,
/// `731 <nick> :target[,target2]*`
RPL_MONOFFLINE = 731,
/// `732 <nick> :target[,target2]*`
RPL_MONLIST = 732,
/// `733 <nick> :End of MONITOR list`
RPL_ENDOFMONLIST = 733,
/// `760 <target> <key> <visibility> :<value>`
RPL_WHOISKEYVALUE = 760,
/// `761 <target> <key> <visibility> :[<value>]`
RPL_KEYVALUE = 761,
/// `762 :end of metadata`
RPL_METADATAEND = 762,
/// `900 <nick> <nick>!<ident>@<host> <account> :You are now logged in as <user>`
RPL_LOGGEDIN = 900,
/// `901 <nick> <nick>!<ident>@<host> :You are now logged out`
RPL_LOGGEDOUT = 901,
/// `903 <nick> :SASL authentication successful`
RPL_SASLSUCCESS = 903,
/// `908 <nick> <mechanisms> :are available SASL mechanisms`
RPL_SASLMECHS = 908,
// Error replies
/// `401 <nickname> :No such nick/channel`
ERR_NOSUCHNICK = 401,
/// `402 <server name> :No such server`
ERR_NOSUCHSERVER = 402,
/// `403 <channel name> :No such channel`
ERR_NOSUCHCHANNEL = 403,
/// `404 <channel name> :Cannot send to channel`
ERR_CANNOTSENDTOCHAN = 404,
/// `405 <channel name> :You have joined too many channels`
ERR_TOOMANYCHANNELS = 405,
/// `406 <nickname> :There was no such nickname`
ERR_WASNOSUCHNICK = 406,
/// `407 <target> :<error code> recipients. <abort message>`
ERR_TOOMANYTARGETS = 407,
/// `408 <service name> :No such service`
ERR_NOSUCHSERVICE = 408,
/// `409 :No origin specified`
ERR_NOORIGIN = 409,
/// `411 :No recipient given (<command>)`
ERR_NORECIPIENT = 411,
/// `412 :No text to send`
ERR_NOTEXTTOSEND = 412,
/// `413 <mask> :No toplevel domain specified`
ERR_NOTOPLEVEL = 413,
/// `414 <mask> :Wildcard in toplevel domain`
ERR_WILDTOPLEVEL = 414,
/// `415 <mask> :Bad Server/host mask`
ERR_BADMASK = 415,
/// `421 <command> :Unknown command`
ERR_UNKNOWNCOMMAND = 421,
/// `422 :MOTD File is missing`
ERR_NOMOTD = 422,
/// `423 <server> :No administrative info available`
ERR_NOADMININFO = 423,
/// `424 :File error doing <file op> on <file>`
ERR_FILEERROR = 424,
/// `431 :No nickname given`
ERR_NONICKNAMEGIVEN = 431,
/// `432 <nick> :Erroneous nickname"`
ERR_ERRONEOUSNICKNAME = 432,
/// `433 <nick> :Nickname is already in use`
ERR_NICKNAMEINUSE = 433,
/// `436 <nick> :Nickname collision KILL from <user>@<host>`
ERR_NICKCOLLISION = 436,
/// `437 <nick/channel> :Nick/channel is temporarily unavailable`
ERR_UNAVAILRESOURCE = 437,
/// `441 <nick> <channel> :They aren't on that channel`
ERR_USERNOTINCHANNEL = 441,
/// `442 <channel> :You're not on that channel`
ERR_NOTONCHANNEL = 442,
/// `443 <user> <channel> :is already on channel`
ERR_USERONCHANNEL = 443,
/// `444 <user> :User not logged in`
ERR_NOLOGIN = 444,
/// `445 :SUMMON has been disabled`
ERR_SUMMONDISABLED = 445,
/// `446 :USERS has been disabled`
ERR_USERSDISABLED = 446,
/// `451 :You have not registered`
ERR_NOTREGISTERED = 451,
/// `461 <command> :Not enough parameters`
ERR_NEEDMOREPARAMS = 461,
/// `462 :Unauthorized command (already registered)`
ERR_ALREADYREGISTRED = 462,
/// `463 :Your host isn't among the privileged`
ERR_NOPERMFORHOST = 463,
/// `464 :Password incorrect`
ERR_PASSWDMISMATCH = 464,
/// `465 :You are banned from this server`
ERR_YOUREBANNEDCREEP = 465,
/// `466`
ERR_YOUWILLBEBANNED = 466,
/// `467 <channel> :Channel key already set`
ERR_KEYSET = 467,
/// `471 <channel> :Cannot join channel (+l)`
ERR_CHANNELISFULL = 471,
/// `472 <char> :is unknown mode char to me for <channel>`
ERR_UNKNOWNMODE = 472,
/// `473 <channel> :Cannot join channel (+i)`
ERR_INVITEONLYCHAN = 473,
/// `474 <channel> :Cannot join channel (+b)`
ERR_BANNEDFROMCHAN = 474,
/// `475 <channel> :Cannot join channel (+k)`
ERR_BADCHANNELKEY = 475,
/// `476 <channel> :Bad Channel Mask`
ERR_BADCHANMASK = 476,
/// `477 <channel> :Channel doesn't support modes`
ERR_NOCHANMODES = 477,
/// `478 <channel> <char> :Channel list is full`
ERR_BANLISTFULL = 478,
/// `481 :Permission Denied- You're not an IRC operator`
ERR_NOPRIVILEGES = 481,
/// `482 <channel> :You're not channel operator`
ERR_CHANOPRIVSNEEDED = 482,
/// `483 :You can't kill a server!`
ERR_CANTKILLSERVER = 483,
/// `484 :Your connection is restricted!`
ERR_RESTRICTED = 484,
/// `485 :You're not the original channel operator`
ERR_UNIQOPPRIVSNEEDED = 485,
/// `491 :No O-lines for your host`
ERR_NOOPERHOST = 491,
/// `501 :Unknown MODE flag`
ERR_UMODEUNKNOWNFLAG = 501,
/// `502 :Cannot change mode for other users`
ERR_USERSDONTMATCH = 502,
/// `734 <nick> <limit> <targets> :Monitor list is full.`
ERR_MONLISTFULL = 734,
/// `764 <target> :metadata limit reached`
ERR_METADATALIMIT = 764,
/// `765 <target> :invalid metadata target`
ERR_TARGETINVALID = 765,
/// `766 <key> :no matching key`
ERR_NOMATCHINGKEY = 766,
/// `767 <key> :invalid metadata key`
ERR_KEYINVALID = 767,
/// `768 <target> <key> :key not set`
ERR_KEYNOTSET = 768,
/// `769 <target> <key> :permission denied`
ERR_KEYNOPERMISSION = 769,
/// `902 <nick> :You must use a nick assigned to you.`
ERR_NICKLOCKED = 902,
/// `904 <nick> :SASL authentication failed`
ERR_SASLFAIL = 904,
/// `905 <nick> :SASL message too long`
ERR_SASLTOOLONG = 905,
/// `906 <nick> :SASL authentication aborted`
ERR_SASLABORT = 906,
/// `907 <nick> :You have already authenticated using SASL`
ERR_SASLALREADY = 907
}
impl Response {
/// Determines whether or not this response is an error response.
pub fn is_error(&self) -> bool {
*self as u16 >= 400
}
}
impl FromStr for Response {
type Err = &'static str;
fn from_str(s: &str) -> Result<Response, &'static str> {
if let Ok(rc) = s.parse() {
match Response::from_u16(rc) {
Some(r) => Ok(r),
None => Err("Failed to parse due to unknown response code."),
}
} else {
Err("Failed to parse response code.")
}
}
}
#[cfg(test)]
mod test {
use super::Response;
#[test]
fn is_error() {
assert!(!Response::RPL_NAMREPLY.is_error());
assert!(Response::ERR_NICKNAMEINUSE.is_error());
}
}