-
Notifications
You must be signed in to change notification settings - Fork 559
/
mod.rs
1417 lines (1281 loc) · 52.5 KB
/
mod.rs
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! The Client contains information about a single bot or user's token, as well
//! as event handlers. Dispatching events to configured handlers and starting
//! the shards' connections are handled directly via the client. In addition,
//! the `rest` module and `Cache` are also automatically handled by the
//! Client module for you.
//!
//! A [`Context`] is provided for every handler. The context is an ergonomic
//! method of accessing the lower-level HTTP functions.
//!
//! The `rest` module is the lower-level method of interacting with the Discord
//! REST API. Realistically, there should be little reason to use this yourself,
//! as the Context will do this for you. A possible use case of using the `rest`
//! module is if you do not have a Cache, for purposes such as low memory
//! requirements.
//!
//! Click [here][Client examples] for an example on how to use a `Client`.
//!
//! [`Client`]: struct.Client.html#examples
//! [`Context`]: struct.Context.html
//! [Client examples]: struct.Client.html#examples
pub mod gateway;
pub mod rest;
mod context;
mod dispatch;
mod error;
mod event_store;
mod login_type;
pub use self::context::Context;
pub use self::error::Error as ClientError;
pub use self::login_type::LoginType;
use self::dispatch::dispatch;
use self::event_store::EventStore;
use self::gateway::Shard;
use std::collections::{BTreeMap, HashMap};
use std::sync::{Arc, Mutex, RwLock};
use std::time::Duration;
use std::{mem, thread};
use typemap::ShareMap;
use websocket::client::Receiver;
use websocket::result::WebSocketError;
use websocket::stream::WebSocketStream;
use ::internal::prelude::{Error, Result, Value};
use ::internal::ws_impl::ReceiverExt;
use ::model::event::{
ChannelPinsAckEvent,
ChannelPinsUpdateEvent,
Event,
GatewayEvent,
GuildSyncEvent,
MessageUpdateEvent,
PresenceUpdateEvent,
ReadyEvent,
ResumedEvent,
TypingStartEvent,
VoiceServerUpdateEvent,
};
use ::model::*;
#[cfg(feature="framework")]
use ::ext::framework::Framework;
#[cfg(feature="cache")]
use ::ext::cache::Cache;
#[cfg(not(feature="cache"))]
use ::model::event::{
CallUpdateEvent,
GuildMemberUpdateEvent,
UserSettingsUpdateEvent,
};
#[cfg(feature="cache")]
lazy_static! {
/// A mutable and lazily-initialized static binding. It can be accessed
/// across any function and in any context.
///
/// This [`Cache`] instance is updated for every event received, so you do
/// not need to maintain your own cache.
///
/// See the [cache module documentation] for more details.
///
/// The Cache itself is wrapped within an `RwLock`, which allows for
/// multiple readers or at most one writer at a time across threads. This
/// means that you may have multiple commands reading from the Cache
/// concurrently.
///
/// # Examples
///
/// Retrieve the [current user][`CurrentUser`]'s Id, by opening a Read
/// guard:
///
/// ```rust,ignore
/// use serenity::client::CACHE;
///
/// println!("{}", CACHE.read().unwrap().user.id);
/// ```
///
/// By `unwrap()`ing, the thread managing an event dispatch will be blocked
/// until the guard can be opened.
///
/// If you do not want to block the current thread, you may instead use
/// `RwLock::try_read`. Refer to `RwLock`'s documentation in the stdlib for
/// more information.
///
/// [`CurrentUser`]: ../model/struct.CurrentUser.html
/// [`Cache`]: ../ext/cache/struct.Cache.html
/// [cache module documentation]: ../ext/cache/index.html
pub static ref CACHE: RwLock<Cache> = RwLock::new(Cache::default());
}
/// The Client is the way to "login" and be able to start sending authenticated
/// requests over the REST API, as well as initializing a WebSocket connection
/// through [`Shard`]s. Refer to the
/// [documentation on using sharding][sharding docs] for more information.
///
/// # Event Handlers
///
/// Event handlers can be configured. For example, the event handler
/// [`on_message`] will be dispatched to whenever a [`Event::MessageCreate`] is
/// received over the connection.
///
/// Note that you do not need to manually handle events, as they are handled
/// internally and then dispatched to your event handlers.
///
/// # Examples
///
/// Creating a Client instance and adding a handler on every message
/// receive, acting as a "ping-pong" bot is simple:
///
/// ```rust,ignore
/// use serenity::Client;
///
/// let mut client = Client::login_bot("my token here");
///
/// client.on_message(|context, message| {
/// if message.content == "!ping" {
/// context.say("Pong!");
/// }
/// });
///
/// client.start();
/// ```
///
/// [`Shard`]: gateway/struct.Shard.html
/// [`on_message`]: #method.on_message
/// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate
/// [sharding docs]: gateway/index.html#sharding
pub struct Client {
/// A ShareMap which requires types to be Send + Sync. This is a map that
/// can be safely shared across contexts.
///
/// The purpose of the data field is to be accessible and persistent across
/// contexts; that is, data can be modified by one context, and will persist
/// through the future and be accessible through other contexts. This is
/// useful for anything that should "live" through the program: counters,
/// database connections, custom user caches, etc.
///
/// In the meaning of a context, this data can be accessed through
/// [`Context::data`].
///
/// Refer to [example 06] for an example on using the `data` field.
///
/// [`Context::data`]: struct.Context.html#method.data
/// [example 06]: https://github.com/zeyla/serenity/tree/master/examples/06_command_framework
pub data: Arc<Mutex<ShareMap>>,
/// A vector of all active shards that have received their [`Event::Ready`]
/// payload, and have dispatched to [`on_ready`] if an event handler was
/// configured.
///
/// [`Event::Ready`]: ../model/event/enum.Event.html#variant.Ready
/// [`on_ready`]: #method.on_ready
event_store: Arc<RwLock<EventStore>>,
#[cfg(feature="framework")]
framework: Arc<Mutex<Framework>>,
login_type: LoginType,
token: String,
}
#[allow(type_complexity)]
impl Client {
/// Creates a Client for a bot user.
///
/// Discord has a requirement of prefixing bot tokens with `"Bot "`, which
/// this function will automatically do for you if not already included.
pub fn login_bot(bot_token: &str) -> Client {
let token = if !bot_token.starts_with("Bot ") {
format!("Bot {}", bot_token)
} else {
bot_token.to_owned()
};
login(token, LoginType::Bot)
}
/// Creates a Client for a user.
///
/// **Note**: Read the notes for [`LoginType::User`] prior to using this, as
/// there are restrictions on usage.
///
/// [`LoginType::User`]: enum.LoginType.html#variant.User
pub fn login_user(user_token: &str) -> Client {
login(user_token.to_owned(), LoginType::User)
}
/// Sets a framework to be used with the client. All message events will be
/// passed through the framework _after_ being passed to the [`on_message`]
/// event handler.
///
/// See the [framework module-level documentation][framework docs] for more
/// information on usage.
///
/// [`on_message`]: #method.on_message
/// [framework docs]: ../ext/framework/index.html
#[cfg(feature="framework")]
pub fn with_framework<F>(&mut self, f: F)
where F: FnOnce(Framework) -> Framework + Send + Sync + 'static {
self.framework = Arc::new(Mutex::new(f(Framework::default())));
}
/// Establish the connection and start listening for events.
///
/// This will start receiving events in a loop and start dispatching the
/// events to your registered handlers.
///
/// Note that this should be used only for users and for bots which are in
/// less than 2500 guilds. If you have a reason for sharding and/or are in
/// more than 2500 guilds, use one of these depending on your use case:
///
/// Refer to the [Gateway documentation][gateway docs] for more information
/// on effectively using sharding.
///
/// [gateway docs]: gateway/index.html#sharding
pub fn start(&mut self) -> Result<()> {
self.start_connection(None, rest::get_gateway()?.url)
}
/// Establish the connection(s) and start listening for events.
///
/// This will start receiving events in a loop and start dispatching the
/// events to your registered handlers.
///
/// This will retrieve an automatically determined number of shards to use
/// from the API - determined by Discord - and then open a number of shards
/// equivalent to that amount.
///
/// Refer to the [Gateway documentation][gateway docs] for more information
/// on effectively using sharding.
///
/// [gateway docs]: gateway/index.html#sharding
pub fn start_autosharded(&mut self) -> Result<()> {
let mut res = rest::get_bot_gateway()?;
let x = res.shards as u64 - 1;
let y = res.shards as u64;
let url = mem::replace(&mut res.url, String::default());
drop(res);
self.start_connection(Some([0, x, y]), url)
}
/// Establish a sharded connection and start listening for events.
///
/// This will start receiving events and dispatch them to your registered
/// handlers.
///
/// This will create a single shard by ID. If using one shard per process,
/// you will need to start other processes with the other shard IDs in some
/// way.
///
/// Refer to the [Gateway documentation][gateway docs] for more information
/// on effectively using sharding.
///
/// [gateway docs]: gateway/index.html#sharding
pub fn start_shard(&mut self, shard: u64, shards: u64) -> Result<()> {
self.start_connection(Some([shard, shard, shards]), rest::get_gateway()?.url)
}
/// Establish sharded connections and start listening for events.
///
/// This will start receiving events and dispatch them to your registered
/// handlers.
///
/// This will create and handle all shards within this single process. If
/// you only need to start a single shard within the process, or a range of
/// shards, use [`start_shard`] or [`start_shard_range`], respectively.
///
/// Refer to the [Gateway documentation][gateway docs] for more information
/// on effectively using sharding.
///
/// [`start_shard`]: #method.start_shard
/// [`start_shard_range`]: #method.start_shards
/// [Gateway docs]: gateway/index.html#sharding
pub fn start_shards(&mut self, total_shards: u64) -> Result<()> {
self.start_connection(Some([0, total_shards - 1, total_shards]), rest::get_gateway()?.url)
}
/// Establish a range of sharded connections and start listening for events.
///
/// This will start receiving events and dispatch them to your registered
/// handlers.
///
/// This will create and handle all shards within a given range within this
/// single process. If you only need to start a single shard within the
/// process, or all shards within the process, use [`start_shard`] or
/// [`start_shards`], respectively.
///
/// Refer to the [Gateway documentation][gateway docs] for more
/// information on effectively using sharding.
///
/// # Examples
///
/// For a bot using a total of 10 shards, initialize shards 4 through 7:
///
/// ```rust,ignore
/// use serenity::Client;
/// use std::env;
///
/// let token = env::var("DISCORD_BOT_TOKEN").unwrap();
/// let mut client = Client::login_bot(&token);
///
/// let _ = client.start_shard_range([4, 7], 10);
/// ```
///
/// [`start_shard`]: #method.start_shard
/// [`start_shards`]: #method.start_shards
/// [Gateway docs]: gateway/index.html#sharding
pub fn start_shard_range(&mut self, range: [u64; 2], total_shards: u64) -> Result<()> {
self.start_connection(Some([range[0], range[1], total_shards]), rest::get_gateway()?.url)
}
/// Attaches a handler for when a [`CallCreate`] is received.
///
/// [`CallCreate`]: ../model/event/enum.Event.html#variant.CallCreate
pub fn on_call_create<F>(&mut self, handler: F)
where F: Fn(Context, Call) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_call_create = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelCreate`] is received.
///
/// [`ChannelCreate`]: ../model/event/enum.Event.html#variant.ChannelCreate
pub fn on_channel_create<F>(&mut self, handler: F)
where F: Fn(Context, Channel) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_create = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelDelete`] is received.
///
/// [`ChannelDelete`]: ../model/event/enum.Event.html#variant.ChannelDelete
pub fn on_channel_delete<F>(&mut self, handler: F)
where F: Fn(Context, Channel) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_delete = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelPinsAck`] is received.
///
/// [`ChannelPinsAck`]: ../model/event/enum.Event.html#variant.ChannelPinsAck
pub fn on_channel_pins_ack<F>(&mut self, handler: F)
where F: Fn(Context, ChannelPinsAckEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_pins_ack = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelPinsUpdate`] is received.
///
/// [`ChannelPinsUpdate`]: ../model/event/enum.Event.html#variant.ChannelPinsUpdate
pub fn on_channel_pins_update<F>(&mut self, handler: F)
where F: Fn(Context, ChannelPinsUpdateEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_pins_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`FriendSuggestionCreate`] is received.
///
/// [`FriendSuggestionCreate`]: ../model/event/enum.Event.html#variant.FriendSuggestionCreate
pub fn on_friend_suggestion_create<F>(&mut self, handler: F)
where F: Fn(Context, User, Vec<SuggestionReason>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_friend_suggestion_create = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`FriendSuggestionDelete`] is received.
///
/// [`FriendSuggestionDelete`]: ../model/event/enum.Event.html#variant.FriendSuggestionDelete
pub fn on_friend_suggestion_delete<F>(&mut self, handler: F)
where F: Fn(Context, UserId) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_friend_suggestion_delete = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildCreate`] is received.
///
/// [`GuildCreate`]: ../model/event/enum.Event.html#variant.GuildCreate
pub fn on_guild_create<F>(&mut self, handler: F)
where F: Fn(Context, Guild) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_create = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildEmojisUpdate`] is received.
///
/// The `HashMap` of emojis is the new full list of emojis.
///
/// [`GuildEmojisUpdate`]: ../model/event/enum.Event.html#variant.GuildEmojisUpdate
pub fn on_guild_emojis_update<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, HashMap<EmojiId, Emoji>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_emojis_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildIntegrationsUpdate`] is received.
///
/// [`GuildIntegrationsUpdate`]: ../model/event/enum.Event.html#variant.GuildIntegrationsUpdate
pub fn on_guild_integrations_update<F>(&mut self, handler: F)
where F: Fn(Context, GuildId) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_integrations_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildMemberAdd`] is received.
///
/// [`GuildMemberAdd`]: ../model/event/enum.Event.html#variant.GuildMemberAdd
pub fn on_guild_member_add<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, Member) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_member_addition = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildMembersChunk`] is received.
///
/// [`GuildMembersChunk`]: ../model/event/enum.Event.html#variant.GuildMembersChunk
pub fn on_guild_members_chunk<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, HashMap<UserId, Member>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_members_chunk = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildRoleCreate`] is received.
///
/// [`GuildRoleCreate`]: ../model/event/enum.Event.html#variant.GuildRoleCreate
pub fn on_guild_role_create<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, Role) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_role_create = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildRoleSync`] is received.
///
/// [`GuildRoleSync`]: ../model/event/enum.Event.html#variant.GuildRoleSync
pub fn on_guild_sync<F>(&mut self, handler: F)
where F: Fn(Context, GuildSyncEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_sync = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildUnavailable`] is received.
///
/// [`GuildUnavailable`]: ../model/event/enum.Event.html#variant.GuildUnavailable
pub fn on_guild_unavailable<F>(&mut self, handler: F)
where F: Fn(Context, GuildId) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_unavailable = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildBan`] is received.
///
/// [`GuildBan`]: ../model/event/enum.Event.html#variant.GuildBan
pub fn on_member_ban<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, User) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_ban_addition = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildUnban`] is received.
///
/// [`GuildUnban`]: ../model/event/enum.Event.html#variant.GuildUnban
pub fn on_member_unban<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, User) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_ban_removal = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`MessageCreate`] is received.
///
/// # Examples
///
/// Print the contents of every received message:
///
/// ```rust,ignore
/// use serenity::Client;
///
/// let mut client = Client::login_bot("bot token here");
///
/// client.on_message(|_context, message| {
/// println!("{}", message.content);
/// });
///
/// let _ = client.start();
/// ```
///
/// [`MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate
pub fn on_message<F>(&mut self, handler: F)
where F: Fn(Context, Message) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_message = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`MessageAck`] is received.
///
/// [`MessageAck`]: ../model/event/enum.Event.html#variant.MessageAck
pub fn on_message_ack<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, Option<MessageId>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_message_ack = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`MessageDelete`] is received.
///
/// [`MessageDelete`]: ../model/event/enum.Event.html#variant.MessageDelete
pub fn on_message_delete<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, MessageId) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_message_delete = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`MessageDeleteBulk`] is received.
///
/// [`MessageDeleteBulk`]: ../model/event/enum.Event.html#variant.MessageDeleteBulk
pub fn on_message_delete_bulk<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, Vec<MessageId>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_message_delete_bulk = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`MessageUpdate`] is received.
///
/// [`MessageUpdate`]: ../model/event/enum.Event.html#variant.MessageUpdate
pub fn on_message_update<F>(&mut self, handler: F)
where F: Fn(Context, MessageUpdateEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_message_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`PresencesReplace`] is received.
///
/// [`PresencesReplace`]: ../model/event/enum.Event.html#variant.PresencesReplace
pub fn on_presence_replace<F>(&mut self, handler: F)
where F: Fn(Context, Vec<Presence>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_presence_replace = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`PresenceUpdate`] is received.
///
/// [`PresenceUpdate`]: ../model/event/enum.Event.html#variant.PresenceUpdate
pub fn on_presence_update<F>(&mut self, handler: F)
where F: Fn(Context, PresenceUpdateEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_presence_update = Some(Arc::new(handler));
}
/// Attached a handler for when a [`ReactionAdd`] is received.
///
/// [`ReactionAdd`]: ../model/event/enum.Event.html#variant.ReactionAdd
pub fn on_reaction_add<F>(&mut self, handler: F)
where F: Fn(Context, Reaction) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_reaction_add = Some(Arc::new(handler));
}
/// Attached a handler for when a [`ReactionRemove`] is received.
///
/// [`ReactionRemove`]: ../model/event/enum.Event.html#variant.ReactionRemove
pub fn on_reaction_remove<F>(&mut self, handler: F)
where F: Fn(Context, Reaction) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_reaction_remove = Some(Arc::new(handler));
}
/// Attached a handler for when a [`ReactionRemoveAll`] is received.
///
/// [`ReactionRemoveAll`]: ../model/event/enum.Event.html#variant.ReactionRemoveAll
pub fn on_reaction_remove_all<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, MessageId) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_reaction_remove_all = Some(Arc::new(handler));
}
/// Register an event to be called whenever a Ready event is received.
///
/// Registering a handler for the ready event is good for noting when your
/// bot has established a connection to the gateway through a [`Shard`].
///
/// **Note**: The Ready event is not guarenteed to be the first event you
/// will receive by Discord. Do not actively rely on it.
///
/// # Examples
///
/// Print the [current user][`CurrentUser`]'s name on ready:
///
/// ```rust,no_run
/// use serenity::Client;
/// use std::env;
///
/// let token = env::var("DISCORD_BOT_TOKEN").unwrap();
/// let mut client = Client::login_bot(&token);
///
/// client.on_ready(|_context, ready| {
/// println!("{} is connected", ready.user.name);
/// });
/// ```
///
/// [`CurrentUser`]: ../model/struct.CurrentUser.html
/// [`Shard`]: gateway/struct.Shard.html
pub fn on_ready<F>(&mut self, handler: F)
where F: Fn(Context, Ready) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_ready = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelRecipientAdd`] is received.
///
/// [`ChannelRecipientAdd`]: ../model/event/enum.Event.html#variant.ChannelRecipientAdd
pub fn on_recipient_add<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, User) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_recipient_addition = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelRecipientRemove`] is received.
///
/// [`ChannelRecipientRemove`]: ../model/event/enum.Event.html#variant.ChannelRecipientRemove
pub fn on_recipient_remove<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, User) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_recipient_removal = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`RelationshipAdd`] is received.
///
/// [`RelationshipAdd`]: ../model/event/enum.Event.html#variant.RelationshipAdd
pub fn on_relationship_add<F>(&mut self, handler: F)
where F: Fn(Context, Relationship) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_relationship_addition = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`RelationshipRemove`] is received.
///
/// [`RelationshipRemove`]: ../model/event/enum.Event.html#variant.RelationshipRemove
pub fn on_relationship_remove<F>(&mut self, handler: F)
where F: Fn(Context, UserId, RelationshipType) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_relationship_removal = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`Resumed`] is received.
///
/// [`Resumed`]: ../model/event/enum.Event.html#variant.Resumed
pub fn on_resume<F>(&mut self, handler: F)
where F: Fn(Context, ResumedEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_resume = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`TypingStart`] is received.
///
/// [`TypingStart`]: ../model/event/enum.Event.html#variant.TypingStart
pub fn on_typing_start<F>(&mut self, handler: F)
where F: Fn(Context, TypingStartEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_typing_start = Some(Arc::new(handler));
}
/// Attaches a handler for when an [`Unknown`] is received.
///
/// [`Unknown`]: ../model/event/enum.Event.html#variant.Unknown
pub fn on_unknown<F>(&mut self, handler: F)
where F: Fn(Context, String, BTreeMap<String, Value>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_unknown = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`VoiceServerUpdate`] is received.
///
/// [`VoiceServerUpdate`]: ../model/event/enum.Event.html#variant.VoiceServerUpdate
pub fn on_voice_server_update<F>(&mut self, handler: F)
where F: Fn(Context, VoiceServerUpdateEvent) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_voice_server_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`VoiceStateUpdate`] is received.
///
/// [`VoiceStateUpdate`]: ../model/event/enum.Event.html#variant.VoiceStateUpdate
pub fn on_voice_state_update<F>(&mut self, handler: F)
where F: Fn(Context, Option<GuildId>, VoiceState) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_voice_state_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`WebhookUpdate`] is received.
///
/// [`WebhookUpdate`]: ../model/event/enum.Event.html#variant.WebhookUpdate
pub fn on_webhook_update<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, ChannelId) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_webhook_update = Some(Arc::new(handler));
}
// Shard data layout is:
// 0: first shard number to initialize
// 1: shard number to initialize up to and including
// 2: total number of shards the bot is sharding for
//
// Not all shards need to be initialized in this process.
fn start_connection(&mut self, shard_data: Option<[u64; 3]>, url: String) -> Result<()> {
// Update the framework's current user if the feature is enabled.
//
// This also acts as a form of check to ensure the token is correct.
#[cfg(feature="framework")]
{
let user = rest::get_current_user()?;
self.framework.lock()
.unwrap()
.update_current_user(user.id, user.bot);
}
let gateway_url = Arc::new(Mutex::new(url));
let shards_index = shard_data.map_or(0, |x| x[0]);
let shards_total = shard_data.map_or(1, |x| x[1] + 1);
for shard_number in shards_index..shards_total {
let shard_info = shard_data.map(|s| [shard_number, s[2]]);
let boot = boot_shard(BootInfo {
gateway_url: gateway_url.clone(),
login_type: self.login_type,
shard_info: shard_info,
token: self.token.clone(),
});
match boot {
Ok((shard, ready, receiver)) => {
#[cfg(feature="cache")]
{
CACHE.write()
.unwrap()
.update_with_ready(&ready);
}
let shard = Arc::new(Mutex::new(shard));
feature_framework! {{
dispatch(Event::Ready(ready),
&shard,
&self.framework,
&self.data,
self.login_type,
&self.event_store);
} else {
dispatch(Event::Ready(ready),
&shard,
&self.data,
self.login_type,
&self.event_store);
}}
let monitor_info = feature_framework! {{
MonitorInfo {
data: self.data.clone(),
event_store: self.event_store.clone(),
framework: self.framework.clone(),
gateway_url: gateway_url.clone(),
login_type: self.login_type,
receiver: receiver,
shard: shard,
shard_info: shard_info,
token: self.token.clone(),
}
} else {
MonitorInfo {
data: self.data.clone(),
event_store: self.event_store.clone(),
gateway_url: gateway_url.clone(),
login_type: self.login_type,
receiver: receiver,
shard: shard,
shard_info: shard_info,
token: self.token.clone(),
}
}};
thread::spawn(move || {
monitor_shard(monitor_info);
});
},
Err(why) => warn!("Error starting shard {:?}: {:?}", shard_info, why),
}
// Wait 5 seconds between shard boots.
//
// We need to wait at least 5 seconds between READYs.
thread::sleep(Duration::from_secs(5));
}
loop {
thread::sleep(Duration::from_secs(1));
}
}
}
#[cfg(feature="cache")]
impl Client {
/// Attaches a handler for when a [`CallDelete`] is received.
///
/// The `ChannelId` is the Id of the channel hosting the call. Returns the
/// call from the cache - optionally - if the call was in it.
///
/// [`CallDelete`]: ../model/event/enum.Event.html#variant.CallDelete
pub fn on_call_delete<F>(&mut self, handler: F)
where F: Fn(Context, ChannelId, Option<Call>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_call_delete = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`CallUpdate`] is received.
///
/// [`CallUpdate`]: ../model/event/enum.Event.html#variant.CallUpdate
pub fn on_call_update<F>(&mut self, handler: F)
where F: Fn(Context, Option<Call>, Option<Call>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_call_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`ChannelUpdate`] is received.
///
/// Optionally provides the version of the channel before the update.
///
/// [`ChannelUpdate`]: ../model/event/enum.Event.html#variant.ChannelUpdate
pub fn on_channel_update<F>(&mut self, handler: F)
where F: Fn(Context, Option<Channel>, Channel) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_channel_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildDelete`] is received.
///
/// Returns a partial guild as well as - optionally - the full guild, with
/// data like [`Role`]s. This can be `None` in the event that it was not in
/// the [`Cache`].
///
/// **Note**: The relevant guild is _removed_ from the Cache when this event
/// is received. If you need to keep it, you can either re-insert it
/// yourself back into the Cache or manage it in another way.
///
/// [`GuildDelete`]: ../model/event/enum.Event.html#variant.GuildDelete
/// [`Role`]: ../model/struct.Role.html
/// [`Cache`]: ../ext/cache/struct.Cache.html
pub fn on_guild_delete<F>(&mut self, handler: F)
where F: Fn(Context, PartialGuild, Option<Guild>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_delete = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildMemberRemove`] is received.
///
/// Returns the user's associated `Member` object, _if_ it existed in the
/// cache.
///
/// [`GuildMemberRemove`]: ../model/event/enum.Event.html#variant.GuildMemberRemove
pub fn on_guild_member_remove<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, User, Option<Member>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_member_removal = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildMemberUpdate`] is received.
///
/// [`GuildMemberUpdate`]: ../model/event/enum.Event.html#variant.GuildMemberUpdate
pub fn on_guild_member_update<F>(&mut self, handler: F)
where F: Fn(Context, Option<Member>, Member) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_member_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildRoleDelete`] is received.
///
/// [`GuildRoleDelete`]: ../model/event/enum.Event.html#variant.GuildRoleDelete
pub fn on_guild_role_delete<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, RoleId, Option<Role>) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_role_delete = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildRoleUpdate`] is received.
///
/// The optional `Role` is the role prior to updating. This can be `None` if
/// it did not exist in the [`Cache`] before the update.
///
/// [`GuildRoleUpdate`]: ../model/event/enum.Event.html#variant.GuildRoleUpdate
/// [`Cache`]: ../ext/cache/struct.Cache.html
pub fn on_guild_role_update<F>(&mut self, handler: F)
where F: Fn(Context, GuildId, Option<Role>, Role) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_role_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`UserGuildSettingsUpdate`] is received.
///
/// [`UserGuildSettingsUpdate`]: ../model/event/enum.Event.html#variant.UserGuildSettingsUpdate
pub fn on_user_guild_settings_update<F>(&mut self, handler: F)
where F: Fn(Context, Option<UserGuildSettings>, UserGuildSettings) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_user_guild_settings_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`GuildUpdate`] is received.
///
/// [`GuildUpdate`]: ../model/event/enum.Event.html#variant.GuildUpdate
pub fn on_guild_update<F>(&mut self, handler: F)
where F: Fn(Context, Option<Guild>, PartialGuild) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_guild_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`UserNoteUpdate`] is received.
///
/// Optionally returns the old note for the [`User`], if one existed.
///
/// [`User`]: ../model/struct.User.html
/// [`UserNoteUpdate`]: ../model/event/enum.Event.html#variant.UserNoteUpdate
pub fn on_note_update<F>(&mut self, handler: F)
where F: Fn(Context, UserId, Option<String>, String) + Send + Sync + 'static {
self.event_store.write()
.unwrap()
.on_note_update = Some(Arc::new(handler));
}
/// Attaches a handler for when a [`UserSettingsUpdate`] is received.
///