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
use crate::client::bridge::gateway::ShardMessenger; use crate::gateway::InterMessage; use crate::model::prelude::*; use parking_lot::RwLock; use std::sync::{ Arc, mpsc::Sender, }; use typemap::ShareMap; #[cfg(feature = "cache")] pub use crate::cache::{Cache, CacheRwLock}; #[cfg(feature = "http")] use crate::http::Http; /// The context is a general utility struct provided on event dispatches, which /// helps with dealing with the current "context" of the event dispatch. /// The context also acts as a general high-level interface over the associated /// [`Shard`] which received the event, or the low-level [`http`] module. /// /// The context contains "shortcuts", like for interacting with the shard. /// Methods like [`set_activity`] will unlock the shard and perform an update for /// you to save a bit of work. /// /// A context will only live for the event it was dispatched for. After the /// event handler finished, it is destroyed and will not be re-used. /// /// [`Shard`]: ../gateway/struct.Shard.html /// [`http`]: ../http/index.html /// [`set_activity`]: #method.set_activity #[derive(Clone)] pub struct Context { /// A clone of [`Client::data`]. Refer to its documentation for more /// information. /// /// [`Client::data`]: struct.Client.html#structfield.data pub data: Arc<RwLock<ShareMap>>, /// The messenger to communicate with the shard runner. pub shard: ShardMessenger, /// The ID of the shard this context is related to. pub shard_id: u64, #[cfg(feature = "cache")] pub cache: CacheRwLock, #[cfg(feature = "http")] pub http: Arc<Http>, } impl Context { /// Create a new Context to be passed to an event handler. #[cfg(all(feature = "cache", feature = "http"))] pub(crate) fn new( data: Arc<RwLock<ShareMap>>, runner_tx: Sender<InterMessage>, shard_id: u64, cache: Arc<RwLock<Cache>>, http: Arc<Http>, ) -> Context { Context { shard: ShardMessenger::new(runner_tx), shard_id, data, cache: cache.into(), http, } } /// Create a new Context to be passed to an event handler. #[cfg(all(not(feature = "cache"), feature = "http"))] pub(crate) fn new( data: Arc<RwLock<ShareMap>>, runner_tx: Sender<InterMessage>, shard_id: u64, http: Arc<Http>, ) -> Context { Context { shard: ShardMessenger::new(runner_tx), shard_id, data, http, } } /// Create a new Context to be passed to an event handler. #[cfg(all(feature = "cache", not(feature = "http")))] pub(crate) fn new( data: Arc<RwLock<ShareMap>>, runner_tx: Sender<InterMessage>, shard_id: u64, cache: Arc<RwLock<Cache>>, ) -> Context { Context { shard: ShardMessenger::new(runner_tx), shard_id, data, cache: cache.into(), } } /// Create a new Context to be passed to an event handler. #[cfg(all(not(feature = "cache"), not(feature = "http")))] pub(crate) fn new( data: Arc<RwLock<ShareMap>>, runner_tx: Sender<InterMessage>, shard_id: u64, ) -> Context { Context { shard: ShardMessenger::new(runner_tx), shard_id, data, } } /// Sets the current user as being [`Online`]. This maintains the current /// activity. /// /// # Examples /// /// Set the current user to being online on the shard: /// /// ```rust,no_run /// # use serenity::prelude::*; /// # use serenity::model::channel::Message; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn message(&self, ctx: Context, msg: Message) { /// if msg.content == "!online" { /// ctx.online(); /// } /// } /// } /// /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// [`Online`]: ../model/user/enum.OnlineStatus.html#variant.Online #[inline] pub fn online(&self) { self.shard.set_status(OnlineStatus::Online); } /// Sets the current user as being [`Idle`]. This maintains the current /// activity. /// /// # Examples /// /// Set the current user to being idle on the shard: /// /// ```rust,no_run /// # use serenity::prelude::*; /// # use serenity::model::channel::Message; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn message(&self, ctx: Context, msg: Message) { /// if msg.content == "!idle" { /// ctx.idle(); /// } /// } /// } /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// [`Idle`]: ../model/user/enum.OnlineStatus.html#variant.Idle #[inline] pub fn idle(&self) { self.shard.set_status(OnlineStatus::Idle); } /// Sets the current user as being [`DoNotDisturb`]. This maintains the /// current activity. /// /// # Examples /// /// Set the current user to being Do Not Disturb on the shard: /// /// ```rust,no_run /// # use serenity::prelude::*; /// # use serenity::model::channel::Message; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn message(&self, ctx: Context, msg: Message) { /// if msg.content == "!dnd" { /// ctx.dnd(); /// } /// } /// } /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// [`DoNotDisturb`]: ../model/user/enum.OnlineStatus.html#variant.DoNotDisturb #[inline] pub fn dnd(&self) { self.shard.set_status(OnlineStatus::DoNotDisturb); } /// Sets the current user as being [`Invisible`]. This maintains the current /// activity. /// /// # Examples /// /// Set the current user to being invisible on the shard when an /// [`Event::Ready`] is received: /// /// ```rust,no_run /// # use serenity::prelude::*; /// # use serenity::model::gateway::Ready; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn ready(&self, ctx: Context, _: Ready) { /// ctx.invisible(); /// } /// } /// /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// [`Event::Ready`]: ../model/event/enum.Event.html#variant.Ready /// [`Invisible`]: ../model/user/enum.OnlineStatus.html#variant.Invisible #[inline] pub fn invisible(&self) { self.shard.set_status(OnlineStatus::Invisible); } /// "Resets" the current user's presence, by setting the activity to `None` /// and the online status to [`Online`]. /// /// Use [`set_presence`] for fine-grained control over individual details. /// /// # Examples /// /// Reset the presence when an [`Event::Resumed`] is received: /// /// ```rust,no_run /// # use serenity::prelude::*; /// # use serenity::model::event::ResumedEvent; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn resume(&self, ctx: Context, _: ResumedEvent) { /// ctx.reset_presence(); /// } /// } /// /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// [`Event::Resumed`]: ../model/event/enum.Event.html#variant.Resumed /// [`Online`]: ../model/user/enum.OnlineStatus.html#variant.Online /// [`set_presence`]: #method.set_presence #[inline] pub fn reset_presence(&self) { self.shard.set_presence(None::<Activity>, OnlineStatus::Online); } /// Sets the current activity, defaulting to an online status of [`Online`]. /// /// # Examples /// /// Create a command named `~setgame` that accepts a name of a game to be /// playing: /// /// ```rust,no_run /// # #[cfg(feature = "model")] /// # fn main() { /// # use serenity::prelude::*; /// # use serenity::model::channel::Message; /// # /// use serenity::model::gateway::Activity; /// /// struct Handler; /// /// impl EventHandler for Handler { /// fn message(&self, ctx: Context, msg: Message) { /// let args = msg.content.splitn(2, ' ').collect::<Vec<&str>>(); /// /// if args.len() < 2 || *unsafe { args.get_unchecked(0) } != "~setgame" { /// return; /// } /// /// ctx.set_activity(Activity::playing(*unsafe { args.get_unchecked(1) })); /// } /// } /// /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// # } /// /// # #[cfg(not(feature = "model"))] /// # fn main() {} /// ``` /// /// [`Online`]: ../model/user/enum.OnlineStatus.html#variant.Online #[inline] pub fn set_activity(&self, activity: Activity) { self.shard.set_presence(Some(activity), OnlineStatus::Online); } /// Sets the current user's presence, providing all fields to be passed. /// /// # Examples /// /// Setting the current user as having no activity and being [`Idle`]: /// /// ```rust,no_run /// # use serenity::prelude::*; /// # use serenity::model::gateway::Ready; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn ready(&self, ctx: Context, _: Ready) { /// use serenity::model::user::OnlineStatus; /// /// ctx.set_presence(None, OnlineStatus::Idle); /// } /// } /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// Setting the current user as playing `"Heroes of the Storm"`, while being /// [`DoNotDisturb`]: /// /// ```rust,ignore /// # use serenity::prelude::*; /// # use serenity::model::gateway::Ready; /// # /// struct Handler; /// /// impl EventHandler for Handler { /// fn ready(&self, context: Context, _: Ready) { /// use serenity::model::gateway::Activity; /// use serenity::model::user::OnlineStatus; /// /// let activity = Activity::playing("Heroes of the Storm"); /// let status = OnlineStatus::DoNotDisturb; /// /// context.set_presence(Some(activity), status); /// } /// } /// /// let mut client = Client::new("token", Handler).unwrap(); /// /// client.start().unwrap(); /// ``` /// /// [`DoNotDisturb`]: ../model/user/enum.OnlineStatus.html#variant.DoNotDisturb /// [`Idle`]: ../model/user/enum.OnlineStatus.html#variant.Idle #[inline] pub fn set_presence(&self, activity: Option<Activity>, status: OnlineStatus) { self.shard.set_presence(activity, status); } } #[cfg(feature = "http")] impl AsRef<Http> for Context { fn as_ref(&self) -> &Http { &self.http } } #[cfg(feature = "cache")] impl AsRef<CacheRwLock> for Context { fn as_ref(&self) -> &CacheRwLock { &self.cache } }