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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
//! The Client contains information about a single bot'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 `http` module and `Cache` are also automatically handled by the //! Client module for you. //! //! A [`Context`] is provided for every handler. //! //! The `http` 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 `http` //! 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 bridge; mod context; mod dispatch; mod error; mod event_handler; pub use self::{ context::Context, error::Error as ClientError, event_handler::{EventHandler, RawEventHandler}, }; #[cfg(any(feature = "cache", feature = "http"))] pub use crate::CacheAndHttp; // Note: the following re-exports are here for backwards compatibility pub use crate::gateway; pub use crate::http as rest; #[cfg(feature = "cache")] pub use crate::cache::{Cache, CacheRwLock}; use crate::internal::prelude::*; use parking_lot::Mutex; use parking_lot::RwLock; use self::bridge::gateway::{ShardManager, ShardManagerMonitor, ShardManagerOptions}; use std::sync::Arc; use threadpool::ThreadPool; use typemap::ShareMap; use log::{error, debug, info}; #[cfg(feature = "framework")] use crate::framework::Framework; #[cfg(feature = "voice")] use crate::model::id::UserId; #[cfg(feature = "voice")] use self::bridge::voice::ClientVoiceManager; #[cfg(feature = "http")] use crate::http::Http; #[cfg(feature = "cache")] use std::time::Duration; struct DummyRawEventHandler; impl RawEventHandler for DummyRawEventHandler {} /// The Client is the way to 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 /// [`EventHandler::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: /// /// ```no_run /// use serenity::prelude::*; /// use serenity::model::prelude::*; /// use serenity::Client; /// /// struct Handler; /// /// impl EventHandler for Handler { /// fn message(&self, context: Context, msg: Message) { /// if msg.content == "!ping" { /// let _ = msg.channel_id.say(&context, "Pong!"); /// } /// } /// } /// /// let mut client = Client::new("my token here", Handler).expect("Could not create new client."); /// /// client.start().expect("Could not start client."); /// ``` /// /// [`Shard`]: ../gateway/struct.Shard.html /// [`EventHandler::message`]: trait.EventHandler.html#tymethod.message /// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate /// [sharding docs]: ../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`]. /// /// # Examples /// /// Create a `MessageEventCounter` to track the following events: /// /// - [`Event::MessageCreate`] /// - [`Event::MessageDelete`] /// - [`Event::MessageDeleteBulk`] /// - [`Event::MessageUpdate`] /// /// ```rust,ignore /// // Of note, this imports `typemap`'s `Key` as `TypeMapKey`. /// use serenity::prelude::*; /// use serenity::model::*; /// use std::collections::HashMap; /// use std::env; /// /// struct MessageEventCounter; /// /// impl TypeMapKey for MessageEventCounter { /// type Value = HashMap<String, u64>; /// } /// /// fn reg<S>(ctx: Context, name: S) /// where S: Into<std::string::String> /// { /// let mut data = ctx.data.write(); /// let counter = data.get_mut::<MessageEventCounter>().unwrap(); /// let entry = counter.entry(name.into()).or_insert(0); /// *entry += 1; /// } /// /// struct Handler; /// /// # #[cfg(all(feature = "client", feature = "standard_framework", feature = "model"))] /// impl EventHandler for Handler { /// fn message(&self, ctx: Context, _: Message) { reg(ctx, "MessageCreate") } /// fn message_delete(&self, ctx: Context, _: ChannelId, _: MessageId) { /// reg(ctx, "MessageDelete") } /// fn message_delete_bulk(&self, ctx: Context, _: ChannelId, _: Vec<MessageId>) { /// reg(ctx, "MessageDeleteBulk") } /// fn message_update(&self, ctx: Context, _: MessageUpdateEvent) { /// reg(ctx, "MessageUpdate") } /// } /// /// # #[cfg(all(feature = "client", feature = "standard_framework", feature = "model"))] /// # fn main() { /// /// let mut client = Client::new(&env::var("DISCORD_TOKEN").expect("Could not find token."), Handler) /// .expect("Could not create client."); /// /// { /// let mut data = client.data.write(); /// data.insert::<MessageEventCounter>(HashMap::default()); /// } /// /// client.start().expect("Could not start client."); /// # } /// ``` /// /// Refer to [example 05] for an example on using the `data` field. /// /// [`Context::data`]: struct.Context.html#structfield.data /// [`Event::MessageCreate`]: ../model/event/enum.Event.html#variant.MessageCreate /// [`Event::MessageDelete`]: ../model/event/enum.Event.html#variant.MessageDelete /// [`Event::MessageDeleteBulk`]: ../model/event/enum.Event.html#variant.MessageDeleteBulk /// [`Event::MessageUpdate`]: ../model/event/enum.Event.html#variant.MessageUpdate /// [example 05]: https://github.com/serenity-rs/serenity/tree/current/examples/05_command_framework pub data: Arc<RwLock<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 #[cfg(feature = "framework")] framework: Arc<Mutex<Option<Box<dyn Framework + Send>>>>, /// A HashMap of all shards instantiated by the Client. /// /// The key is the shard ID and the value is the shard itself. /// /// # Examples /// /// If you call [`client.start_shard(3, 5)`][`Client::start_shard`], this /// HashMap will only ever contain a single key of `3`, as that's the only /// Shard the client is responsible for. /// /// If you call [`client.start_shards(10)`][`Client::start_shards`], this /// HashMap will contain keys 0 through 9, one for each shard handled by the /// client. /// /// Printing the number of shards currently instantiated by the client every /// 5 seconds: /// /// ```rust,no_run /// # extern crate serenity; /// # /// # use serenity::client::{Client, EventHandler}; /// # use std::error::Error; /// # use std::time::Duration; /// # use std::{env, thread}; /// /// # fn try_main() -> Result<(), Box<Error>> { /// /// struct Handler; /// /// impl EventHandler for Handler { } /// /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?, Handler)?; /// /// let shard_manager = client.shard_manager.clone(); /// /// thread::spawn(move || { /// loop { /// println!("Shard count instantiated: {}", /// shard_manager.lock().shards_instantiated().len()); /// /// thread::sleep(Duration::from_millis(5000)); /// } /// }); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// Shutting down all connections after one minute of operation: /// /// ```rust,no_run /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::{Client, EventHandler}; /// use std::time::Duration; /// use std::{env, thread}; /// /// struct Handler; /// /// impl EventHandler for Handler { } /// /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?, Handler)?; /// /// // Create a clone of the `Arc` containing the shard manager. /// let shard_manager = client.shard_manager.clone(); /// /// // Create a thread which will sleep for 60 seconds and then have the /// // shard manager shutdown. /// thread::spawn(move || { /// thread::sleep(Duration::from_secs(60)); /// /// shard_manager.lock().shutdown_all(); /// /// println!("Shutdown shard manager!"); /// }); /// /// println!("Client shutdown: {:?}", client.start()); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// [`Client::start_shard`]: #method.start_shard /// [`Client::start_shards`]: #method.start_shards pub shard_manager: Arc<Mutex<ShardManager>>, shard_manager_worker: ShardManagerMonitor, /// The threadpool shared by all shards. /// /// Defaults to 5 threads, which should suffice small bots. Consider /// increasing this number as your bot grows. pub threadpool: ThreadPool, /// The voice manager for the client. /// /// This is an ergonomic structure for interfacing over shards' voice /// connections. #[cfg(feature = "voice")] pub voice_manager: Arc<Mutex<ClientVoiceManager>>, /// URI that the client's shards will use to connect to the gateway. /// /// This is likely not important for production usage and is, at best, used /// for debugging. /// /// This is wrapped in an `Arc<Mutex<T>>` so all shards will have an updated /// value available. pub ws_uri: Arc<Mutex<String>>, pub cache_and_http: Arc<CacheAndHttp>, } 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. /// /// # Examples /// /// Create a Client, using a token from an environment variable: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// struct Handler; /// /// impl EventHandler for Handler {} /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let client = Client::new(&token, Handler)?; /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` pub fn new<H>(token: impl AsRef<str>, handler: H) -> Result<Self> where H: EventHandler + Send + Sync + 'static { Self::new_with_handlers(token.as_ref(), Some(handler), None::<DummyRawEventHandler>) } /// Creates a client with an optional Handler. If you pass `None`, events are never parsed, but /// they can be received by registering a RawHandler. pub fn new_with_handlers<H, RH>(token: impl AsRef<str>, handler: Option<H>, raw_handler: Option<RH>) -> Result<Self> where H: EventHandler + Send + Sync + 'static, RH: RawEventHandler + Send + Sync + 'static { let token = token.as_ref().trim(); let token = if token.starts_with("Bot ") { token.to_string() } else { format!("Bot {}", token) }; let http = Http::new_with_token(&token); let name = "serenity client".to_owned(); let threadpool = ThreadPool::with_name(name, 5); let url = Arc::new(Mutex::new(http.get_gateway()?.url)); let data = Arc::new(RwLock::new(ShareMap::custom())); let event_handler = handler.map(Arc::new); let raw_event_handler = raw_handler.map(Arc::new); #[cfg(feature = "framework")] let framework = Arc::new(Mutex::new(None)); #[cfg(feature = "voice")] let voice_manager = Arc::new(Mutex::new(ClientVoiceManager::new( 0, UserId(0), ))); let cache_and_http = Arc::new(CacheAndHttp { #[cfg(feature = "cache")] cache: Arc::new(RwLock::new(Cache::default())), #[cfg(feature = "cache")] update_cache_timeout: None, #[cfg(feature = "http")] http: Arc::new(http), __nonexhaustive: (), }); let (shard_manager, shard_manager_worker) = { ShardManager::new(ShardManagerOptions { data: &data, event_handler: &event_handler, raw_event_handler: &raw_event_handler, #[cfg(feature = "framework")] framework: &framework, shard_index: 0, shard_init: 0, shard_total: 0, threadpool: threadpool.clone(), #[cfg(feature = "voice")] voice_manager: &voice_manager, ws_url: &url, cache_and_http: &cache_and_http, }) }; Ok(Client { ws_uri: url, #[cfg(feature = "framework")] framework, data, shard_manager, shard_manager_worker, threadpool, #[cfg(feature = "voice")] voice_manager, cache_and_http, }) } /// Creates a Client for a bot user and sets a cache update timeout. /// If set to some duration, updating the cache will try to claim a /// write-lock for given duration and skip received event but also /// issue a deadlock-warning upon failure. /// If `duration` is set to `None`, updating the cache will try to claim /// a write-lock until success and potentially deadlock. /// /// Discord has a requirement of prefixing bot tokens with `"Bot "`, which /// this function will automatically do for you if not already included. /// /// # Examples /// /// Create a Client, using a token from an environment variable: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// struct Handler; /// /// impl EventHandler for Handler {} /// # use std::error::Error; /// # /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let client = Client::new_with_cache_update_timeout(&token, Handler, None)?; /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` #[cfg(all(feature = "cache", feature = "http"))] pub fn new_with_cache_update_timeout<H>(token: impl AsRef<str>, handler: H, duration: Option<Duration>) -> Result<Self> where H: EventHandler + Send + Sync + 'static { let token = token.as_ref().trim(); let token = if token.starts_with("Bot ") { token.to_string() } else { format!("Bot {}", token) }; let http = Http::new_with_token(&token); let name = "serenity client".to_owned(); let threadpool = ThreadPool::with_name(name, 5); let url = Arc::new(Mutex::new(http.get_gateway()?.url)); let data = Arc::new(RwLock::new(ShareMap::custom())); let event_handler = Some(Arc::new(handler)); #[cfg(feature = "framework")] let framework = Arc::new(Mutex::new(None)); #[cfg(feature = "voice")] let voice_manager = Arc::new(Mutex::new(ClientVoiceManager::new( 0, UserId(0), ))); let cache_and_http = Arc::new(CacheAndHttp { cache: Arc::new(RwLock::new(Cache::default())), update_cache_timeout: duration, #[cfg(feature = "http")] http: Arc::new(http), __nonexhaustive: (), }); let (shard_manager, shard_manager_worker) = { ShardManager::new(ShardManagerOptions { data: &data, event_handler: &event_handler, raw_event_handler: &None::<Arc<DummyRawEventHandler>>, #[cfg(feature = "framework")] framework: &framework, shard_index: 0, shard_init: 0, shard_total: 0, threadpool: threadpool.clone(), #[cfg(feature = "voice")] voice_manager: &voice_manager, ws_url: &url, cache_and_http: &cache_and_http, }) }; Ok(Client { ws_uri: url, #[cfg(feature = "framework")] framework, data, shard_manager, shard_manager_worker, threadpool, #[cfg(feature = "voice")] voice_manager, cache_and_http, }) } /// Sets a framework to be used with the client. All message events will be /// passed through the framework _after_ being passed to the [`message`] /// event handler. /// /// See the [framework module-level documentation][framework docs] for more /// information on usage. /// /// # Examples /// /// Create a simple framework that responds to a `~ping` command: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// /// use std::env; /// /// use serenity::framework::StandardFramework; /// use serenity::client::{Client, Context}; /// use serenity::model::channel::Message; /// use serenity::framework::standard::{CommandResult, macros::{group, command}}; /// /// #[command] /// fn ping(ctx: &mut Context, msg: &Message) -> CommandResult { /// msg.channel_id.say(&ctx.http, "Pong!")?; /// Ok(()) /// } /// /// // Commands must be intermediately handled through groups. /// group!({ /// name: "pingpong", /// options: {}, /// commands: [ping], /// }); /// # /// # fn try_main() -> Result<(), Box<Error>> { /// /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?, Handler)?; /// client.with_framework(StandardFramework::new() /// .configure(|c| c.prefix("~")) /// // The macros generate instances of command and group structs, which reside as `static` variables. /// // Hence the uppercase name, and the suffix for distinguishment. /// .group(&PINGPONG_GROUP)); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// Using your own framework: /// /// ```rust,ignore /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// use serenity::Framework; /// use serenity::client::Context; /// use serenity::model::*; /// use tokio_core::reactor::Handle; /// use std::collections::HashMap; /// /// /// struct MyFramework { /// commands: HashMap<String, Box<Fn(Message, Vec<String>)>>, /// } /// /// impl Framework for MyFramework { /// fn dispatch(&mut self, _: Context, msg: Message, tokio_handle: &Handle) { /// let args = msg.content.split_whitespace(); /// let command = match args.advance() { /// Some(command) => { /// if !command.starts_with('*') { return; } /// command /// }, /// None => return, /// }; /// /// let command = match self.commands.get(&command) { /// Some(command) => command, None => return, /// }; /// /// tokio_handle.spawn_fn(move || { (command)(msg, args); Ok() }); /// } /// } /// /// struct Handler; /// /// impl EventHandler for Handler {} /// /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::Client; /// use std::env; /// /// let mut client = Client::new(&token, Handler).unwrap(); /// client.with_framework(MyFramework { commands: { /// let mut map = HashMap::new(); /// map.insert("ping".to_string(), Box::new(|msg, _| msg.channel_id.say("pong!"))); /// map /// }}); /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// Refer to the documentation for the `framework` module for more in-depth /// information. /// /// [`message`]: trait.EventHandler.html#method.message /// [framework docs]: ../framework/index.html #[cfg(feature = "framework")] pub fn with_framework<F: Framework + Send + 'static>(&mut self, f: F) { *self.framework.lock() = Some(Box::new(f)); } /// 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. /// /// # Examples /// /// Starting a Client with only 1 shard, out of 1 total: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let mut client = Client::new(&token, Handler).unwrap(); /// /// if let Err(why) = client.start() { /// println!("Err with client: {:?}", why); /// } /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// [gateway docs]: ../gateway/index.html#sharding #[cfg(feature = "http")] pub fn start(&mut self) -> Result<()> { self.start_connection([0, 0, 1]) } /// 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. /// /// # Examples /// /// Start as many shards as needed using autosharding: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let mut client = Client::new(&token, Handler).unwrap(); /// /// if let Err(why) = client.start_autosharded() { /// println!("Err with client: {:?}", why); /// } /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns a [`ClientError::Shutdown`] when all shards have shutdown due to /// an error. /// /// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown /// [gateway docs]: ../gateway/index.html#sharding #[cfg(feature = "http")] pub fn start_autosharded(&mut self) -> Result<()> { let (x, y) = { let res = self.cache_and_http.http.get_bot_gateway()?; (res.shards as u64 - 1, res.shards as u64) }; self.start_connection([0, x, y]) } /// 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. /// /// # Examples /// /// Start shard 3 of 5: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let mut client = Client::new(&token, Handler).unwrap(); /// /// if let Err(why) = client.start_shard(3, 5) { /// println!("Err with client: {:?}", why); /// } /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// Start shard 0 of 1 (you may also be interested in [`start`] or /// [`start_autosharded`]): /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::Client; /// use std::env; /// /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?, Handler)?; /// /// if let Err(why) = client.start_shard(0, 1) { /// println!("Err with client: {:?}", why); /// } /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns a [`ClientError::Shutdown`] when all shards have shutdown due to /// an error. /// /// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown /// [`start`]: #method.start /// [`start_autosharded`]: #method.start_autosharded /// [gateway docs]: ../gateway/index.html#sharding #[cfg(feature = "http")] pub fn start_shard(&mut self, shard: u64, shards: u64) -> Result<()> { self.start_connection([shard, shard, shards]) } /// 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. /// /// # Examples /// /// Start all of 8 shards: /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let mut client = Client::new(&token, Handler).unwrap(); /// /// if let Err(why) = client.start_shards(8) { /// println!("Err with client: {:?}", why); /// } /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns a [`ClientError::Shutdown`] when all shards have shutdown due to /// an error. /// /// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown /// [`start_shard`]: #method.start_shard /// [`start_shard_range`]: #method.start_shard_range /// [Gateway docs]: ../gateway/index.html#sharding #[cfg(feature = "http")] pub fn start_shards(&mut self, total_shards: u64) -> Result<()> { self.start_connection([0, total_shards - 1, total_shards]) } /// 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: /// /// ```no_run /// # use serenity::prelude::EventHandler; /// struct Handler; /// /// impl EventHandler for Handler {} /// use serenity::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN").unwrap(); /// let mut client = Client::new(&token, Handler).unwrap(); /// /// let _ = client.start_shard_range([4, 7], 10); /// ``` /// /// ```rust,no_run /// # use serenity::prelude::EventHandler; /// # use std::error::Error; /// # /// struct Handler; /// /// impl EventHandler for Handler {} /// # fn try_main() -> Result<(), Box<Error>> { /// use serenity::client::Client; /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; /// let mut client = Client::new(&token, Handler).unwrap(); /// /// if let Err(why) = client.start_shard_range([4, 7], 10) { /// println!("Err with client: {:?}", why); /// } /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// # Errors /// /// Returns a [`ClientError::Shutdown`] when all shards have shutdown due to /// an error. /// /// /// [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown /// [`start_shard`]: #method.start_shard /// [`start_shards`]: #method.start_shards /// [Gateway docs]: ../gateway/index.html#sharding #[cfg(feature = "http")] pub fn start_shard_range(&mut self, range: [u64; 2], total_shards: u64) -> Result<()> { self.start_connection([range[0], range[1], total_shards]) } // 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. // // # Errors // // Returns a [`ClientError::Shutdown`] when all shards have shutdown due to // an error. // // [`ClientError::Shutdown`]: enum.ClientError.html#variant.Shutdown #[cfg(feature = "http")] fn start_connection(&mut self, shard_data: [u64; 3]) -> Result<()> { #[cfg(feature = "voice")] self.voice_manager.lock().set_shard_count(shard_data[2]); #[cfg(feature = "voice")] { let user = self.cache_and_http.http.get_current_user()?; self.voice_manager.lock().set_user_id(user.id); } { let mut manager = self.shard_manager.lock(); let init = shard_data[1] - shard_data[0] + 1; manager.set_shards(shard_data[0], init, shard_data[2]); debug!( "Initializing shard info: {} - {}/{}", shard_data[0], init, shard_data[2], ); if let Err(why) = manager.initialize() { error!("Failed to boot a shard: {:?}", why); info!("Shutting down all shards"); manager.shutdown_all(); return Err(Error::Client(ClientError::ShardBootFailure)); } } self.shard_manager_worker.run(); Ok(()) } } /// Validates that a token is likely in a valid format. /// /// This performs the following checks on a given token: /// /// - At least one character long; /// - Contains 3 parts (split by the period char `'.'`); /// - The second part of the token is at least 6 characters long; /// - The token does not contain any whitespace prior to or after the token. /// /// # Examples /// /// Validate that a token is valid and that a number of invalid tokens are /// actually invalid: /// /// ```rust,no_run /// use serenity::client::validate_token; /// /// // ensure a valid token is in fact valid: /// assert!(validate_token("Mjg4NzYwMjQxMzYzODc3ODg4.C_ikow.j3VupLBuE1QWZng3TMGH0z_UAwg").is_ok()); /// /// // "cat" isn't a valid token: /// assert!(validate_token("cat").is_err()); /// /// // tokens must have three parts, separated by periods (this is still /// // actually an invalid token): /// assert!(validate_token("aaa.abcdefgh.bbb").is_ok()); /// /// // the second part must be _at least_ 6 characters long: /// assert!(validate_token("a.abcdef.b").is_ok()); /// assert!(validate_token("a.abcde.b").is_err()); /// ``` /// /// # Errors /// /// Returns a [`ClientError::InvalidToken`] when one of the above checks fail. /// The type of failure is not specified. /// /// [`ClientError::InvalidToken`]: enum.ClientError.html#variant.InvalidToken pub fn validate_token(token: impl AsRef<str>) -> Result<()> { let token = token.as_ref(); if token.is_empty() { return Err(Error::Client(ClientError::InvalidToken)); } let parts: Vec<&str> = token.split('.').collect(); // Check that the token has a total of 3 parts. if parts.len() != 3 { return Err(Error::Client(ClientError::InvalidToken)); } // Check that the second part is at least 6 characters long. if parts[1].len() < 6 { return Err(Error::Client(ClientError::InvalidToken)); } // Check that there is no whitespace before/after the token. if token.trim() != token { return Err(Error::Client(ClientError::InvalidToken)); } Ok(()) }