diff --git a/examples/01_basic_ping_bot/src/main.rs b/examples/01_basic_ping_bot/src/main.rs index 477aea18e4a..25bc52a9d96 100644 --- a/examples/01_basic_ping_bot/src/main.rs +++ b/examples/01_basic_ping_bot/src/main.rs @@ -11,7 +11,7 @@ fn main() { // Create a new instance of the Client, logging in as a bot. This will // automatically prepend your bot token with "Bot ", which is a requirement // by Discord for bot users. - let mut client = Client::login(&token); + let mut client = Client::new(&token); // Set a handler for the `on_message` event - so that whenever a new message // is received - the closure (or function) passed will be called. diff --git a/examples/02_transparent_guild_sharding/src/main.rs b/examples/02_transparent_guild_sharding/src/main.rs index b256cfde79e..a4f6172d4b3 100644 --- a/examples/02_transparent_guild_sharding/src/main.rs +++ b/examples/02_transparent_guild_sharding/src/main.rs @@ -25,7 +25,7 @@ fn main() { // Configure the client with your Discord bot token in the environment. let token = env::var("DISCORD_TOKEN") .expect("Expected a token in the environment"); - let mut client = Client::login(&token); + let mut client = Client::new(&token); client.on_message(|ctx, msg| { if msg.content == "!ping" { diff --git a/examples/03_struct_utilities/src/main.rs b/examples/03_struct_utilities/src/main.rs index 455d0069a07..8802fbaa28d 100644 --- a/examples/03_struct_utilities/src/main.rs +++ b/examples/03_struct_utilities/src/main.rs @@ -7,7 +7,7 @@ fn main() { // Configure the client with your Discord bot token in the environment. let token = env::var("DISCORD_TOKEN") .expect("Expected a token in the environment"); - let mut client = Client::login(&token); + let mut client = Client::new(&token); client.on_message(|_ctx, msg| { if msg.content == "!messageme" { diff --git a/examples/04_message_builder/src/main.rs b/examples/04_message_builder/src/main.rs index 54f3b794591..e82d6b986a6 100644 --- a/examples/04_message_builder/src/main.rs +++ b/examples/04_message_builder/src/main.rs @@ -8,7 +8,7 @@ fn main() { // Configure the client with your Discord bot token in the environment. let token = env::var("DISCORD_TOKEN") .expect("Expected a token in the environment"); - let mut client = Client::login(&token); + let mut client = Client::new(&token); client.on_message(|_ctx, msg| { if msg.content == "!ping" { diff --git a/examples/05_command_framework/src/main.rs b/examples/05_command_framework/src/main.rs index c8abb9d1701..4d5ead4ca58 100644 --- a/examples/05_command_framework/src/main.rs +++ b/examples/05_command_framework/src/main.rs @@ -32,7 +32,7 @@ fn main() { // Configure the client with your Discord bot token in the environment. let token = env::var("DISCORD_TOKEN") .expect("Expected a token in the environment"); - let mut client = Client::login(&token); + let mut client = Client::new(&token); { let mut data = client.data.lock().unwrap(); diff --git a/examples/06_voice/src/main.rs b/examples/06_voice/src/main.rs index 6bc7fb5e3ec..52363765fb0 100644 --- a/examples/06_voice/src/main.rs +++ b/examples/06_voice/src/main.rs @@ -20,7 +20,7 @@ fn main() { // Configure the client with your Discord bot token in the environment. let token = env::var("DISCORD_TOKEN") .expect("Expected a token in the environment"); - let mut client = Client::login(&token); + let mut client = Client::new(&token); client.with_framework(|f| f .configure(|c| c diff --git a/examples/07_sample_bot_structure/src/main.rs b/examples/07_sample_bot_structure/src/main.rs index 85600ebd15a..42ccd64d140 100644 --- a/examples/07_sample_bot_structure/src/main.rs +++ b/examples/07_sample_bot_structure/src/main.rs @@ -18,7 +18,7 @@ use serenity::Client; use std::env; fn main() { - let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap()); + let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap()); client.with_framework(|f| f .configure(|c| c.prefix("~")) diff --git a/src/builder/create_embed.rs b/src/builder/create_embed.rs index 7b676bee0aa..fd0f58cd568 100644 --- a/src/builder/create_embed.rs +++ b/src/builder/create_embed.rs @@ -195,7 +195,7 @@ impl CreateEmbed { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// client.on_message(|_, msg| { /// if msg.content == "~embed" { @@ -214,7 +214,7 @@ impl CreateEmbed { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::CACHE; /// diff --git a/src/builder/create_invite.rs b/src/builder/create_invite.rs index bd76ed8451c..62f86574328 100644 --- a/src/builder/create_invite.rs +++ b/src/builder/create_invite.rs @@ -14,7 +14,7 @@ use ::internal::prelude::*; /// ```rust,no_run /// # use serenity::Client; /// # -/// # let mut client = Client::login(""); +/// # let mut client = Client::new(""); /// # /// use serenity::client::CACHE; /// diff --git a/src/builder/edit_profile.rs b/src/builder/edit_profile.rs index 2d4df85efbf..7a3a5224e95 100644 --- a/src/builder/edit_profile.rs +++ b/src/builder/edit_profile.rs @@ -21,7 +21,7 @@ impl EditProfile { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// # client.on_message(|context, _| { /// # diff --git a/src/cache/mod.rs b/src/cache/mod.rs index 5058d38aea6..90581c1b487 100644 --- a/src/cache/mod.rs +++ b/src/cache/mod.rs @@ -203,7 +203,7 @@ impl Cache { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::client::CACHE; /// use std::thread; @@ -285,7 +285,7 @@ impl Cache { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::client::CACHE; /// @@ -392,7 +392,7 @@ impl Cache { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// # client.on_message(|ctx, message| { /// # diff --git a/src/client/context.rs b/src/client/context.rs index 0ab4eb5a0dc..5d366473016 100644 --- a/src/client/context.rs +++ b/src/client/context.rs @@ -79,7 +79,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// # client.on_message(|ctx, msg| { /// # if msg.content == "!changename" { @@ -124,7 +124,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// client.on_message(|ctx, msg| { /// if msg.content == "!online" { /// ctx.online(); @@ -147,7 +147,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// client.on_message(|ctx, msg| { /// if msg.content == "!idle" { /// ctx.idle(); @@ -170,7 +170,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// client.on_message(|ctx, msg| { /// if msg.content == "!dnd" { /// ctx.dnd(); @@ -194,7 +194,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// client.on_ready(|ctx, _| { /// ctx.invisible(); /// }); @@ -218,7 +218,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// client.on_resume(|ctx, _| { /// ctx.reset_presence(); /// }); @@ -243,7 +243,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::model::Game; /// @@ -281,7 +281,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// client.on_ready(|ctx, _| { /// ctx.set_game_name("test"); @@ -316,7 +316,7 @@ impl Context { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// # client.on_ready(|ctx, _| { /// # @@ -332,7 +332,7 @@ impl Context { /// ```rust,ignore /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// # client.on_ready(|ctx, _| { /// # diff --git a/src/client/mod.rs b/src/client/mod.rs index bdaa2aa22bb..ec2af1ef5ea 100644 --- a/src/client/mod.rs +++ b/src/client/mod.rs @@ -55,10 +55,10 @@ use ::model::*; #[cfg(feature="framework")] use ::framework::Framework; -/// 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. +/// 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 /// @@ -77,7 +77,7 @@ use ::framework::Framework; /// ```rust,ignore /// use serenity::Client; /// -/// let mut client = Client::login("my token here"); +/// let mut client = Client::new("my token here"); /// /// client.on_message(|context, message| { /// if message.content == "!ping" { @@ -129,7 +129,7 @@ pub struct Client { /// type Value = HashMap; /// } /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap()); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap()); /// /// { /// let mut data = client.data.lock().unwrap(); @@ -176,15 +176,6 @@ pub struct Client { #[allow(type_complexity)] impl Client { - /// Alias of [`login`]. - /// - /// [`login`]: #method.login - #[deprecated(since="0.1.5", note="Use `login` instead")] - #[inline] - pub fn login_bot(token: &str) -> Self { - Self::login(token) - } - /// Creates a Client for a bot user. /// /// Discord has a requirement of prefixing bot tokens with `"Bot "`, which @@ -202,7 +193,7 @@ impl Client { /// use std::env; /// /// let token = env::var("DISCORD_TOKEN")?; - /// let client = Client::login(&token); + /// let client = Client::new(&token); /// # Ok(()) /// # } /// # @@ -210,14 +201,32 @@ impl Client { /// # try_main().unwrap(); /// # } /// ``` - pub fn login(bot_token: &str) -> Self { - let token = if bot_token.starts_with("Bot ") { - bot_token.to_owned() + pub fn new(token: &str) -> Self { + let token = if token.starts_with("Bot ") { + token.to_owned() } else { - format!("Bot {}", bot_token) + format!("Bot {}", token) }; - login(token) + init_client(token) + } + + /// Alias of [`new`]. + /// + /// [`new`]: #method.new + #[deprecated(since="0.1.5", note="Use `new` instead")] + #[inline(always)] + pub fn login_bot(token: &str) -> Self { + Self::new(token) + } + + /// Alias for [`new`]. + /// + /// [`new`]: #method.new + #[deprecated(since="0.2.1", note="Use `new` instead")] + #[inline(always)] + pub fn login(token: &str) -> Self { + Self::new(token) } /// Sets a framework to be used with the client. All message events will be @@ -238,7 +247,7 @@ impl Client { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// client.with_framework(|f| f /// .configure(|c| c.prefix("~")) /// .command("ping", |c| c.exec_str("Pong!"))); @@ -284,7 +293,7 @@ impl Client { /// use serenity::client::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// /// if let Err(why) = client.start() { /// println!("Err with client: {:?}", why); @@ -325,7 +334,7 @@ impl Client { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// /// if let Err(why) = client.start_autosharded() { /// println!("Err with client: {:?}", why); @@ -374,7 +383,7 @@ impl Client { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// /// if let Err(why) = client.start_shard(3, 5) { /// println!("Err with client: {:?}", why); @@ -397,7 +406,7 @@ impl Client { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// /// if let Err(why) = client.start_shard(0, 1) { /// println!("Err with client: {:?}", why); @@ -440,7 +449,7 @@ impl Client { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// /// if let Err(why) = client.start_shards(8) { /// println!("Err with client: {:?}", why); @@ -482,7 +491,7 @@ impl Client { /// use std::env; /// /// let token = env::var("DISCORD_BOT_TOKEN").unwrap(); - /// let mut client = Client::login(&token); + /// let mut client = Client::new(&token); /// /// let _ = client.start_shard_range([4, 7], 10); /// ``` @@ -494,7 +503,7 @@ impl Client { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN")?); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN")?); /// /// if let Err(why) = client.start_shard_range([4, 7], 10) { /// println!("Err with client: {:?}", why); @@ -524,7 +533,7 @@ impl Client { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// use serenity::model::Channel; /// /// client.on_channel_create(|ctx, channel| { @@ -554,7 +563,7 @@ impl Client { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// use serenity::model::{Channel, ChannelId}; /// /// client.on_channel_delete(|ctx, channel| { @@ -693,7 +702,7 @@ impl Client { /// ```rust,ignore /// use serenity::Client; /// - /// let mut client = Client::login("bot token here"); + /// let mut client = Client::new("bot token here"); /// /// client.on_message(|_context, message| { /// println!("{}", message.content); @@ -808,7 +817,7 @@ impl Client { /// use std::env; /// /// let token = env::var("DISCORD_BOT_TOKEN").unwrap(); - /// let mut client = Client::login(&token); + /// let mut client = Client::new(&token); /// /// client.on_ready(|_context, ready| { /// println!("{} is connected", ready.user.name); @@ -1387,7 +1396,7 @@ fn handle_shard(info: &mut MonitorInfo) { } } -fn login(token: String) -> Client { +fn init_client(token: String) -> Client { http::set_token(&token); feature_framework! {{ diff --git a/src/framework/configuration.rs b/src/framework/configuration.rs index 1b8df305d7e..0a1c351180f 100644 --- a/src/framework/configuration.rs +++ b/src/framework/configuration.rs @@ -19,7 +19,7 @@ use ::model::{GuildId, UserId}; /// use serenity::Client; /// use std::env; /// -/// let mut client = Client::login(&env::var("DISCORD_BOT_TOKEN").unwrap()); +/// let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap()); /// /// client.with_framework(|f| f /// .configure(|c| c.on_mention(true).prefix("~"))); @@ -100,7 +100,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// use serenity::model::GuildId; /// /// client.with_framework(|f| f.configure(|c| c @@ -121,7 +121,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// use serenity::model::UserId; /// /// client.with_framework(|f| f.configure(|c| c @@ -155,7 +155,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// /// let disabled = vec!["ping"].into_iter().map(|x| x.to_owned()).collect(); /// @@ -182,7 +182,7 @@ impl Configuration { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// client.with_framework(|f| f /// .command("ping", |c| c.exec_str("Pong!")) /// .configure(|c| c.dynamic_prefix(|ctx| { @@ -261,7 +261,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// use serenity::model::UserId; /// /// client.with_framework(|f| f.configure(|c| c @@ -272,7 +272,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// use serenity::model::UserId; /// use std::collections::HashSet; /// @@ -288,7 +288,7 @@ impl Configuration { self } - /// Sets the prefix to respond to. A prefix can be a string slice of any + /// Sets the prefix to respond to. A prefix can be a string slice of any /// non-zero length. /// /// # Examples @@ -297,7 +297,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f.configure(|c| c /// .prefix("!"))); @@ -317,7 +317,7 @@ impl Configuration { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f.configure(|c| c /// .prefixes(vec!["!", ">", "+"]))); diff --git a/src/framework/create_command.rs b/src/framework/create_command.rs index a31c91a349e..9aed52f1641 100644 --- a/src/framework/create_command.rs +++ b/src/framework/create_command.rs @@ -38,7 +38,7 @@ impl CreateCommand { /// use serenity::model::Message; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap()); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap()); /// /// client.with_framework(|f| f /// .configure(|c| c.prefix("~")) diff --git a/src/framework/help_commands.rs b/src/framework/help_commands.rs index a4dbe76f2d6..964aa41ee05 100644 --- a/src/framework/help_commands.rs +++ b/src/framework/help_commands.rs @@ -10,7 +10,8 @@ //! use serenity::Client; //! use std::env; //! -//! let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap()); +//! let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap()); +//! //! client.with_framework(|f| f //! .command("help", |c| c.exec_help(help_commands::with_embeds))); //! ``` @@ -59,7 +60,9 @@ fn remove_aliases(cmds: &HashMap) -> HashMap<&String, &I /// /// ```rust /// # use serenity::Client; -/// # let mut client = Client::login("token"); +/// # +/// # let mut client = Client::new("token"); +/// # /// use serenity::ext::framework::help_commands; /// /// client.with_framework(|f| f @@ -206,7 +209,9 @@ pub fn with_embeds(ctx: &mut Context, /// /// ```rust /// # use serenity::Client; -/// # let mut client = Client::login("token"); +/// # +/// # let mut client = Client::new("token"); +/// # /// use serenity::ext::framework::help_commands; /// /// client.with_framework(|f| f diff --git a/src/framework/mod.rs b/src/framework/mod.rs index 20da1888173..63a83b4a378 100644 --- a/src/framework/mod.rs +++ b/src/framework/mod.rs @@ -36,7 +36,7 @@ //! use serenity::model::Message; //! use std::env; //! -//! let mut client = Client::login(&env::var("DISCORD_BOT_TOKEN").unwrap()); +//! let mut client = Client::new(&env::var("DISCORD_BOT_TOKEN").unwrap()); //! //! client.with_framework(|f| f //! .configure(|c| c.prefix("~")) @@ -255,7 +255,7 @@ impl Framework { /// use serenity::Client; /// use std::env; /// - /// let mut client = Client::login(&env::var("DISCORD_TOKEN").unwrap()); + /// let mut client = Client::new(&env::var("DISCORD_TOKEN").unwrap()); /// client.with_framework(|f| f /// .configure(|c| c /// .depth(3) @@ -285,7 +285,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f /// .bucket("basic", 2, 10, 3) @@ -314,7 +314,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f /// .simple_bucket("simple", 2) @@ -593,7 +593,7 @@ impl Framework { /// # /// # fn main() { /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f.on("ping", ping)); /// @@ -671,7 +671,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f /// .group("ping-pong", |g| g @@ -699,7 +699,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// use serenity::framework::DispatchError::{NotEnoughArguments, TooManyArguments}; /// /// client.with_framework(|f| f @@ -735,7 +735,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f /// .before(|ctx, msg, cmd_name| { @@ -748,7 +748,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f /// .before(|_, msg, cmd_name| { @@ -781,7 +781,7 @@ impl Framework { /// /// ```rust /// # use serenity::Client; - /// # let mut client = Client::login("token"); + /// # let mut client = Client::new("token"); /// # /// client.with_framework(|f| f /// .after(|ctx, msg, cmd_name, error| { diff --git a/src/gateway/shard.rs b/src/gateway/shard.rs index 343aa0601e2..d449a819048 100644 --- a/src/gateway/shard.rs +++ b/src/gateway/shard.rs @@ -513,7 +513,8 @@ impl Shard { /// ```rust,no_run /// # use serenity::client::Client; /// # - /// # let mut client = Client::login("hello source code viewer <3"); + /// # let mut client = Client::new("hello source code viewer <3"); + /// # /// client.on_message(|ctx, msg| { /// if msg.content == "~ping" { /// if let Some(latency) = ctx.shard.lock().unwrap().latency() { diff --git a/src/lib.rs b/src/lib.rs index 4e0f2677c67..f6e9f0ae0ce 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,7 +2,7 @@ //! //! View the [examples] on how to make and structure a bot. //! -//! Serenity supports bot user authentication via the use of [`Client::login`]. +//! Serenity supports bot user authentication via the use of [`Client::new`]. //! //! Once logged in, you may add handlers to your client to dispatch [`Event`]s, //! such as [`Client::on_message`]. This will cause your handler to be called @@ -37,7 +37,7 @@ //! //! fn main() { //! // Login with a bot token from the environment -//! let mut client = Client::login(&env::var("DISCORD_TOKEN").expect("token")); +//! let mut client = Client::new(&env::var("DISCORD_TOKEN").expect("token")); //! client.with_framework(|f| f //! .configure(|c| c.prefix("~")) // set the bot's prefix to "~" //! .on("ping", ping)); @@ -72,7 +72,7 @@ //! ``` //! //! [`Cache`]: cache/struct.Cache.html -//! [`Client::login`]: client/struct.Client.html#method.login +//! [`Client::new`]: client/struct.Client.html#method.new //! [`Client::on_message`]: client/struct.Client.html#method.on_message //! [`Context`]: client/struct.Context.html //! [`Event`]: model/event/enum.Event.html diff --git a/src/model/channel/attachment.rs b/src/model/channel/attachment.rs index 54b84eaaf24..015c18e46c3 100644 --- a/src/model/channel/attachment.rs +++ b/src/model/channel/attachment.rs @@ -53,7 +53,7 @@ impl Attachment { /// use std::path::Path; /// /// let token = env::var("DISCORD_TOKEN").expect("token in environment"); - /// let mut client = Client::login(&token); + /// let mut client = Client::new(&token); /// /// client.on_message(|_, message| { /// for attachment in message.attachments { diff --git a/src/model/channel/guild_channel.rs b/src/model/channel/guild_channel.rs index 5ce70316d13..4f47d28317f 100644 --- a/src/model/channel/guild_channel.rs +++ b/src/model/channel/guild_channel.rs @@ -415,7 +415,7 @@ impl GuildChannel { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::CACHE; /// @@ -438,7 +438,7 @@ impl GuildChannel { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::CACHE; /// use serenity::model::permissions; diff --git a/src/model/channel/message.rs b/src/model/channel/message.rs index 612113dc8a2..e0927038cd5 100644 --- a/src/model/channel/message.rs +++ b/src/model/channel/message.rs @@ -81,7 +81,7 @@ impl Message { /// # use serenity::Client; /// # /// # fn main() { - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::model::Channel; /// diff --git a/src/model/error.rs b/src/model/error.rs index 6d0295b1bf9..5f3f2ec6e7d 100644 --- a/src/model/error.rs +++ b/src/model/error.rs @@ -18,7 +18,7 @@ use super::Permissions; /// use std::env; /// /// let token = env::var("DISCORD_BOT_TOKEN").unwrap(); -/// let mut client = Client::login(&token); +/// let mut client = Client::new(&token); /// /// client.on_member_unban(|context, guild_id, user| { /// // If the user has an even discriminator, don't re-ban them. diff --git a/src/model/user.rs b/src/model/user.rs index 8f4d2d9ad64..65346a3ca51 100644 --- a/src/model/user.rs +++ b/src/model/user.rs @@ -400,7 +400,7 @@ impl User { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::model::Permissions; /// use serenity::CACHE; @@ -591,7 +591,7 @@ impl User { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::model::UserId; /// use serenity::CACHE; @@ -655,7 +655,7 @@ impl User { /// ```rust,no_run /// # use serenity::Client; /// # - /// # let mut client = Client::login(""); + /// # let mut client = Client::new(""); /// # /// use serenity::utils::MessageBuilder; /// use serenity::utils::ContentModifier::Bold;