Struct serenity::client::bridge::gateway::ShardMessenger [−][src]
pub struct ShardMessenger { /* fields omitted */ }
Expand description
A lightweight wrapper around an mpsc sender.
This is used to cleanly communicate with a shard’s respective
ShardRunner
. This can be used for actions such as setting the activity
via Self::set_activity
or shutting down via Self::shutdown_clean
.
Implementations
impl ShardMessenger
[src]
impl ShardMessenger
[src]pub fn new(tx: Sender<InterMessage>) -> Self
[src]
pub fn new(tx: Sender<InterMessage>) -> Self
[src]Creates a new shard messenger.
If you are using the Client
, you do not need to do this.
pub fn chunk_guild(
&self,
guild_id: GuildId,
limit: Option<u16>,
filter: ChunkGuildFilter,
nonce: Option<String>
)
[src]
pub fn chunk_guild(
&self,
guild_id: GuildId,
limit: Option<u16>,
filter: ChunkGuildFilter,
nonce: Option<String>
)
[src]Requests that one or multiple Guild
s be chunked.
This will ask the gateway to start sending member chunks for large guilds (250 members+). If a guild is over 250 members, then a full member list will not be downloaded, and must instead be requested to be sent in “chunks” containing members.
Member chunks are sent as the Event::GuildMembersChunk
event. Each
chunk only contains a partial amount of the total members.
If the cache
feature is enabled, the cache will automatically be
updated with member chunks.
Examples
Chunk a single guild by Id, limiting to 2000 Member
s, and not
specifying a query parameter:
use serenity::model::id::GuildId; shard.chunk_guild(GuildId(81384788765712384), Some(2000), ChunkGuildFilter::None, None);
Chunk a single guild by Id, limiting to 20 members, specifying a
query parameter of "do"
and a nonce of "request"
:
use serenity::model::id::GuildId; shard.chunk_guild(GuildId(81384788765712384), Some(20), ChunkGuildFilter::Query("do".to_owned()), Some("request"));
pub fn set_activity(&self, activity: Option<Activity>)
[src]
pub fn set_activity(&self, activity: Option<Activity>)
[src]Sets the user’s current activity, if any.
Other presence settings are maintained.
Examples
Setting the current activity to playing "Heroes of the Storm"
:
use serenity::model::gateway::Activity; shard.set_activity(Some(Activity::playing("Heroes of the Storm")));
pub fn set_presence(&self, activity: Option<Activity>, status: OnlineStatus)
[src]
pub fn set_presence(&self, activity: Option<Activity>, status: OnlineStatus)
[src]Sets the user’s full presence information.
Consider using the individual setters if you only need to modify one of these.
Examples
Set the current user as playing "Heroes of the Storm"
and being
online:
use serenity::model::gateway::Activity; use serenity::model::user::OnlineStatus; let activity = Activity::playing("Heroes of the Storm"); shard.set_presence(Some(activity), OnlineStatus::Online);
pub fn set_status(&self, online_status: OnlineStatus)
[src]
pub fn set_status(&self, online_status: OnlineStatus)
[src]Sets the user’s current online status.
Note that Offline
is not a valid online status, so it is
automatically converted to Invisible
.
Other presence settings are maintained.
Examples
Setting the current online status for the shard to DoNotDisturb
.
use serenity::model::user::OnlineStatus; shard.set_status(OnlineStatus::DoNotDisturb);
pub fn shutdown_clean(&self)
[src]
pub fn shutdown_clean(&self)
[src]Shuts down the websocket by attempting to cleanly close the connection.
pub fn websocket_message(&self, message: Message)
[src]
pub fn websocket_message(&self, message: Message)
[src]Sends a raw message over the WebSocket.
The given message is not mutated in any way, and is sent as-is.
You should only use this if you know what you’re doing. If you’re
wanting to, for example, send a presence update, prefer the usage of
the Self::set_presence
method.
pub fn send_to_shard(
&self,
msg: ShardRunnerMessage
) -> Result<(), TrySendError<InterMessage>>
[src]
pub fn send_to_shard(
&self,
msg: ShardRunnerMessage
) -> Result<(), TrySendError<InterMessage>>
[src]pub fn set_message_filter(&self, collector: MessageFilter)
[src]
This is supported on crate feature collector
only.
pub fn set_message_filter(&self, collector: MessageFilter)
[src]collector
only.Sets a new filter for a message collector.
pub fn set_reaction_filter(&self, collector: ReactionFilter)
[src]
This is supported on crate feature collector
only.
pub fn set_reaction_filter(&self, collector: ReactionFilter)
[src]collector
only.Sets a new filter for a message collector.
Trait Implementations
impl AsRef<ShardMessenger> for ShardMessenger
[src]
impl AsRef<ShardMessenger> for ShardMessenger
[src]fn as_ref(&self) -> &ShardMessenger
[src]
fn as_ref(&self) -> &ShardMessenger
[src]Performs the conversion.
impl AsRef<ShardMessenger> for ShardRunnerInfo
[src]
impl AsRef<ShardMessenger> for ShardRunnerInfo
[src]fn as_ref(&self) -> &ShardMessenger
[src]
fn as_ref(&self) -> &ShardMessenger
[src]Performs the conversion.
impl AsRef<ShardMessenger> for Context
[src]
impl AsRef<ShardMessenger> for Context
[src]fn as_ref(&self) -> &ShardMessenger
[src]
fn as_ref(&self) -> &ShardMessenger
[src]Performs the conversion.
impl Clone for ShardMessenger
[src]
impl Clone for ShardMessenger
[src]fn clone(&self) -> ShardMessenger
[src]
fn clone(&self) -> ShardMessenger
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for ShardMessenger
impl Send for ShardMessenger
impl Sync for ShardMessenger
impl Unpin for ShardMessenger
impl !UnwindSafe for ShardMessenger
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Instrument for T
[src]
impl<T> Instrument for T
[src]fn instrument(self, span: Span) -> Instrumented<Self>
[src]
fn instrument(self, span: Span) -> Instrumented<Self>
[src]Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
fn in_current_span(self) -> Instrumented<Self>
[src]
fn in_current_span(self) -> Instrumented<Self>
[src]impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,