Struct serenity::model::id::GuildId [−][src]
pub struct GuildId(pub u64);
Expand description
An identifier for a Guild
Implementations
impl GuildId
[src]
impl GuildId
[src]pub async fn ban(
self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8
) -> Result<()>
[src]
pub async fn ban(
self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8
) -> Result<()>
[src]Ban a User
from the guild, deleting a number of
days’ worth of messages (dmd
) between the range 0 and 7.
Refer to the documentation for Guild::ban
for more information.
Note: Requires the Ban Members permission.
Examples
Ban a member and remove all messages they’ve sent in the last 4 days:
use serenity::model::id::UserId; use serenity::model::id::GuildId; // assuming a `user` has already been bound let _ = GuildId(81384788765712384).ban(&http, user, 4).await;
Errors
Returns a ModelError::DeleteMessageDaysAmount
if the number of
days’ worth of messages to delete is over the maximum.
Also can return Error::Http
if the current user lacks permission.
pub async fn ban_with_reason(
self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8,
reason: impl AsRef<str>
) -> Result<()>
[src]
pub async fn ban_with_reason(
self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8,
reason: impl AsRef<str>
) -> Result<()>
[src]Ban a User
from the guild with a reason. Refer to Self::ban
to further documentation.
Errors
In addition to the reasons Self::ban
may return an error, may
also return Error::ExceededLimit
if reason
is too long.
pub async fn bans(self, http: impl AsRef<Http>) -> Result<Vec<Ban>>
[src]
pub async fn bans(self, http: impl AsRef<Http>) -> Result<Vec<Ban>>
[src]Gets a list of the guild’s bans.
Note: Requires the Ban Members permission.
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn audit_logs(
self,
http: impl AsRef<Http>,
action_type: Option<u8>,
user_id: Option<UserId>,
before: Option<AuditLogEntryId>,
limit: Option<u8>
) -> Result<AuditLogs>
[src]
pub async fn audit_logs(
self,
http: impl AsRef<Http>,
action_type: Option<u8>,
user_id: Option<UserId>,
before: Option<AuditLogEntryId>,
limit: Option<u8>
) -> Result<AuditLogs>
[src]Gets a list of the guild’s audit log entries
Note: Requires the View Audit Log permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an invalid value is given.
pub async fn channels(
self,
http: impl AsRef<Http>
) -> Result<HashMap<ChannelId, GuildChannel>>
[src]
pub async fn channels(
self,
http: impl AsRef<Http>
) -> Result<HashMap<ChannelId, GuildChannel>>
[src]Gets all of the guild’s channels over the REST API.
Errors
Returns Error::Http
if the current user is not in
the guild.
pub async fn create_channel(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>
[src]
pub async fn create_channel(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>
[src]Creates a GuildChannel
in the the guild.
Refer to Http::create_channel
for more information.
Requires the Manage Channels permission.
Examples
Create a voice channel in a guild with the name test
:
use serenity::model::id::GuildId; use serenity::model::channel::ChannelType; let _channel = GuildId(7).create_channel(&http, |c| c.name("test").kind(ChannelType::Voice)).await;
Errors
Returns Error::Http
if the current user lacks permission,
or if invalid values are set.
pub async fn create_emoji(
self,
http: impl AsRef<Http>,
name: &str,
image: &str
) -> Result<Emoji>
[src]
pub async fn create_emoji(
self,
http: impl AsRef<Http>,
name: &str,
image: &str
) -> Result<Emoji>
[src]Creates an emoji in the guild with a name and base64-encoded image.
Refer to the documentation for Guild::create_emoji
for more
information.
Requires the Manage Emojis permission.
Examples
See the EditProfile::avatar
example for an in-depth example as to
how to read an image from the filesystem and encode it as base64. Most
of the example can be applied similarly for this method.
Errors
Returns Error::Http
if the current user lacks permission,
if the name is too long, or if the image is too big.
pub async fn create_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str
) -> Result<()>
[src]
pub async fn create_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str
) -> Result<()>
[src]Creates an integration for the guild.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn create_role<F>(self, http: impl AsRef<Http>, f: F) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
[src]
pub async fn create_role<F>(self, http: impl AsRef<Http>, f: F) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
[src]Creates a new role in the guild with the data set, if any.
See the documentation for Guild::create_role
on how to use this.
Note: Requires the Manage Roles permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if invalid data is given.
pub async fn delete(self, http: impl AsRef<Http>) -> Result<PartialGuild>
[src]
pub async fn delete(self, http: impl AsRef<Http>) -> Result<PartialGuild>
[src]Deletes the current guild if the current account is the owner of the guild.
Refer to Guild::delete
for more information.
Note: Requires the current user to be the owner of the guild.
Errors
Returns Error::Http
if the current user is not the owner of the guild.
pub async fn delete_emoji(
self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>
) -> Result<()>
[src]
pub async fn delete_emoji(
self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>
) -> Result<()>
[src]Deletes an Emoji
from the guild.
Note: Requires the Manage Emojis permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an Emoji with that Id does not exist.
pub async fn delete_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
[src]
pub async fn delete_integration(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
[src]Deletes an integration by Id from the guild.
Note: Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an integration with that Id does not exist.
pub async fn delete_role(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>
) -> Result<()>
[src]
pub async fn delete_role(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>
) -> Result<()>
[src]Deletes a Role
by Id from the guild.
Also see Role::delete
if you have the cache
and model
features
enabled.
Note: Requires the Manage Roles permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if a role with that Id does not exist.
pub async fn edit<F>(
&mut self,
http: impl AsRef<Http>,
f: F
) -> Result<PartialGuild> where
F: FnOnce(&mut EditGuild) -> &mut EditGuild,
[src]
pub async fn edit<F>(
&mut self,
http: impl AsRef<Http>,
f: F
) -> Result<PartialGuild> where
F: FnOnce(&mut EditGuild) -> &mut EditGuild,
[src]Edits the current guild with new data where specified.
Refer to Guild::edit
for more information.
Note: Requires the current user to have the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an invalid value is set.
pub async fn edit_emoji(
self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>,
name: &str
) -> Result<Emoji>
[src]
pub async fn edit_emoji(
self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>,
name: &str
) -> Result<Emoji>
[src]Edits an Emoji
’s name in the guild.
Also see Emoji::edit
if you have the cache
and methods
features
enabled.
Requires the Manage Emojis permission.
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn edit_member<F>(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
f: F
) -> Result<Member> where
F: FnOnce(&mut EditMember) -> &mut EditMember,
[src]
pub async fn edit_member<F>(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
f: F
) -> Result<Member> where
F: FnOnce(&mut EditMember) -> &mut EditMember,
[src]Edits the properties of member of the guild, such as muting or nicknaming them.
Refer to EditMember
’s documentation for a full list of methods and
permission restrictions.
Examples
Mute a member and set their roles to just one role with a predefined Id:
guild.edit_member(&context, user_id, |m| m.mute(true).roles(&vec![role_id]));
Errors
Returns Error::Http
if the current user lacks the necessary permissions.
pub async fn edit_nickname(
self,
http: impl AsRef<Http>,
new_nickname: Option<&str>
) -> Result<()>
[src]
pub async fn edit_nickname(
self,
http: impl AsRef<Http>,
new_nickname: Option<&str>
) -> Result<()>
[src]Edits the current user’s nickname for the guild.
Pass None
to reset the nickname.
Requires the Change Nickname permission.
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn edit_role<F>(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
f: F
) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
[src]
pub async fn edit_role<F>(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
f: F
) -> Result<Role> where
F: FnOnce(&mut EditRole) -> &mut EditRole,
[src]Edits a Role
, optionally setting its new fields.
Requires the Manage Roles permission.
Examples
Make a role hoisted:
use serenity::model::{GuildId, RoleId}; GuildId(7).edit_role(&context, RoleId(8), |r| r.hoist(true));
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn edit_role_position(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
position: u64
) -> Result<Vec<Role>>
[src]
pub async fn edit_role_position(
self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
position: u64
) -> Result<Vec<Role>>
[src]Edits the order of Role
s
Requires the Manage Roles permission.
Examples
Change the order of a role:
use serenity::model::{GuildId, RoleId}; GuildId(7).edit_role_position(&context, RoleId(8), 2);
Errors
Returns an Error::Http
if the current user lacks permission.
pub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWelcomeScreen> where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
[src]
pub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWelcomeScreen> where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
[src]Edits the GuildWelcomeScreen
.
Errors
Returns an Error::Http
if some mandatory fields are not provided.
pub async fn edit_widget<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWidget> where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
[src]
pub async fn edit_widget<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<GuildWidget> where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
[src]Edits the GuildWidget
.
Errors
Returns an Error::Http
if the bot does not have the MANAGE_GUILD
permission.
pub async fn to_guild_cached(self, cache: impl AsRef<Cache>) -> Option<Guild>
[src]
pub async fn to_guild_cached(self, cache: impl AsRef<Cache>) -> Option<Guild>
[src]Tries to find the Guild
by its Id in the cache.
pub async fn to_partial_guild(
self,
http: impl AsRef<Http>
) -> Result<PartialGuild>
[src]
pub async fn to_partial_guild(
self,
http: impl AsRef<Http>
) -> Result<PartialGuild>
[src]Requests PartialGuild
over REST API.
Note: This will not be a Guild
, as the REST API does not send
all data with a guild retrieval.
Errors
Returns an Error::Http
if the current user is not in the guild.
pub async fn to_partial_guild_with_counts(
self,
http: impl AsRef<Http>
) -> Result<PartialGuild>
[src]
pub async fn to_partial_guild_with_counts(
self,
http: impl AsRef<Http>
) -> Result<PartialGuild>
[src]Requests PartialGuild
over REST API with counts.
Note: This will not be a Guild
, as the REST API does not send
all data with a guild retrieval.
Errors
Returns an Error::Http
if the current user is not in the guild.
pub async fn emoji(
&self,
http: impl AsRef<Http>,
emoji_id: EmojiId
) -> Result<Emoji>
[src]
pub async fn emoji(
&self,
http: impl AsRef<Http>,
emoji_id: EmojiId
) -> Result<Emoji>
[src]Gets an Emoji
of this guild by its ID via HTTP.
Errors
Returns an Error::Http
if an emoji with that Id does not exist.
pub async fn integrations(
self,
http: impl AsRef<Http>
) -> Result<Vec<Integration>>
[src]
pub async fn integrations(
self,
http: impl AsRef<Http>
) -> Result<Vec<Integration>>
[src]Gets all integration of the guild.
Requires the Manage Guild permission.
Errors
Returns an Error::Http
if the current user lacks permission,
also may return Error::Json
if there is an error in deserializing
the API response.
pub async fn invites(self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>>
[src]
pub async fn invites(self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>>
[src]Gets all of the guild’s invites.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
also may return Error::Json
if there is an error in
deserializing the API response.
pub async fn kick(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
[src]
pub async fn kick(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
[src]Kicks a Member
from the guild.
Requires the Kick Members permission.
Errors
Returns Error::Http
if the member cannot be kicked by
the current user.
pub async fn kick_with_reason(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
reason: &str
) -> Result<()>
[src]
pub async fn kick_with_reason(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
reason: &str
) -> Result<()>
[src]Errors
In addition to the reasons Self::kick
may return an error,
may also return an error if the reason is too long.
pub async fn leave(self, http: impl AsRef<Http>) -> Result<()>
[src]
pub async fn leave(self, http: impl AsRef<Http>) -> Result<()>
[src]Leaves the guild.
Errors
May return an Error::Http
if the current user
cannot leave the guild, or currently is not in the guild.
pub async fn member(
self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>
) -> Result<Member>
[src]
pub async fn member(
self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>
) -> Result<Member>
[src]Gets a user’s Member
for the guild by Id.
If the cache feature is enabled the cache will be checked first. If not found it will resort to an http request.
Errors
Returns an Error::Http
if the user is not in the guild,
or if the guild is otherwise unavailable
pub async fn members(
self,
http: impl AsRef<Http>,
limit: Option<u64>,
after: impl Into<Option<UserId>>
) -> Result<Vec<Member>>
[src]
pub async fn members(
self,
http: impl AsRef<Http>,
limit: Option<u64>,
after: impl Into<Option<UserId>>
) -> Result<Vec<Member>>
[src]Gets a list of the guild’s members.
Optionally pass in the limit
to limit the number of results.
Minimum value is 1, maximum and default value is 1000.
Optionally pass in after
to offset the results by a User
’s Id.
Errors
Returns an Error::Http
if the API returns an error, may also
return Error::NotInRange
if the input is not within range.
pub fn members_iter<H: AsRef<Http>>(
self,
http: H
) -> impl Stream<Item = Result<Member>>
[src]
pub fn members_iter<H: AsRef<Http>>(
self,
http: H
) -> impl Stream<Item = Result<Member>>
[src]Streams over all the members in a guild.
This is accomplished and equivalent to repeated calls to Self::members
.
A buffer of at most 1,000 members is used to reduce the number of calls
necessary.
Examples
use serenity::model::guild::MembersIter; use serenity::futures::StreamExt; let mut members = guild_id.members_iter(&ctx).boxed(); while let Some(member_result) = members.next().await { match member_result { Ok(member) => println!( "{} is {}", member, member.display_name(), ), Err(error) => eprintln!("Uh oh! Error: {}", error), } }
pub async fn move_member(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
channel_id: impl Into<ChannelId>
) -> Result<Member>
[src]
pub async fn move_member(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
channel_id: impl Into<ChannelId>
) -> Result<Member>
[src]Moves a member to a specific voice channel.
Requires the Move Members permission.
Errors
Returns an Error::Http
if the current user
lacks permission, or if the member is not currently
in a voice channel for this Guild
.
pub async fn name(self, cache: impl AsRef<Cache>) -> Option<String>
[src]
pub async fn name(self, cache: impl AsRef<Cache>) -> Option<String>
[src]Returns the name of whatever guild this id holds.
pub async fn disconnect_member(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<Member>
[src]
pub async fn disconnect_member(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<Member>
[src]Disconnects a member from a voice channel in the guild.
Requires the Move Members permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if the member is not currently in a voice channel for this guild.
pub async fn prune_count(
self,
http: impl AsRef<Http>,
days: u16
) -> Result<GuildPrune>
[src]
pub async fn prune_count(
self,
http: impl AsRef<Http>,
days: u16
) -> Result<GuildPrune>
[src]Gets the number of Member
s that would be pruned with the given
number of days.
Requires the Kick Members permission.
Errors
Returns Error::Http
if the current user does not have permission.
pub async fn reorder_channels<It>(
self,
http: impl AsRef<Http>,
channels: It
) -> Result<()> where
It: IntoIterator<Item = (ChannelId, u64)>,
[src]
pub async fn reorder_channels<It>(
self,
http: impl AsRef<Http>,
channels: It
) -> Result<()> where
It: IntoIterator<Item = (ChannelId, u64)>,
[src]Re-orders the channels of the guild.
Accepts an iterator of a tuple of the channel ID to modify and its new position.
Although not required, you should specify all channels’ positions, regardless of whether they were updated. Otherwise, positioning can sometimes get weird.
Note: Requires the Manage Channels permission.
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn shard_id(self, cache: impl AsRef<Cache>) -> u64
[src]
pub async fn shard_id(self, cache: impl AsRef<Cache>) -> u64
[src]Returns the Id of the shard associated with the guild.
When the cache is enabled this will automatically retrieve the total number of shards.
Note: When the cache is enabled, this function unlocks the cache to
retrieve the total number of shards in use. If you already have the
total, consider using utils::shard_id
.
pub async fn start_integration_sync(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
[src]
pub async fn start_integration_sync(
self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>
) -> Result<()>
[src]Starts an integration sync for the given integration Id.
Requires the Manage Guild permission.
Errors
Returns Error::Http
if the current user lacks permission,
or if an Integration
with that Id does not exist.
pub async fn start_prune(
self,
http: impl AsRef<Http>,
days: u16
) -> Result<GuildPrune>
[src]
pub async fn start_prune(
self,
http: impl AsRef<Http>,
days: u16
) -> Result<GuildPrune>
[src]Starts a prune of Member
s.
See the documentation on GuildPrune
for more information.
Note: Requires the Kick Members permission.
Errors
Returns Error::Http
if the current user lacks permission.
pub async fn unban(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
[src]
pub async fn unban(
self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>
) -> Result<()>
[src]Unbans a User
from the guild.
Note: Requires the Ban Members permission.
Errors
Returns Error::Http
if the current user does not have permission.
pub async fn vanity_url(self, http: impl AsRef<Http>) -> Result<String>
[src]
pub async fn vanity_url(self, http: impl AsRef<Http>) -> Result<String>
[src]Retrieve’s the guild’s vanity URL.
Note: Requires the Manage Guild permission.
Errors
Will return Error::Http
if the current user lacks permission.
Can also return Error::Json
if there is an error deserializing
the API response.
pub async fn webhooks(self, http: impl AsRef<Http>) -> Result<Vec<Webhook>>
[src]
pub async fn webhooks(self, http: impl AsRef<Http>) -> Result<Vec<Webhook>>
[src]Retrieves the guild’s webhooks.
Note: Requires the Manage Webhooks permission.
Errors
Will return an Error::Http
if the bot is lacking permissions.
Can also return an Error::Json
if there is an error deserializing
the API response.
pub fn await_reply<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> CollectReply<'a>ⓘNotable traits for CollectReply<'a>
impl<'a> Future for CollectReply<'a> type Output = Option<Arc<Message>>;
[src]
This is supported on crate feature collector
only.
pub fn await_reply<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> CollectReply<'a>ⓘNotable traits for CollectReply<'a>
impl<'a> Future for CollectReply<'a> type Output = Option<Arc<Message>>;
[src]collector
only.Returns a future that will await one message sent in this guild.
pub fn await_replies<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> MessageCollectorBuilder<'a>ⓘNotable traits for MessageCollectorBuilder<'a>
impl<'a> Future for MessageCollectorBuilder<'a> type Output = MessageCollector;
[src]
This is supported on crate feature collector
only.
pub fn await_replies<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> MessageCollectorBuilder<'a>ⓘNotable traits for MessageCollectorBuilder<'a>
impl<'a> Future for MessageCollectorBuilder<'a> type Output = MessageCollector;
[src]collector
only.Returns a stream builder which can be awaited to obtain a stream of messages in this guild.
pub fn await_reaction<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> CollectReaction<'a>ⓘNotable traits for CollectReaction<'a>
impl<'a> Future for CollectReaction<'a> type Output = Option<Arc<ReactionAction>>;
[src]
This is supported on crate feature collector
only.
pub fn await_reaction<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> CollectReaction<'a>ⓘNotable traits for CollectReaction<'a>
impl<'a> Future for CollectReaction<'a> type Output = Option<Arc<ReactionAction>>;
[src]collector
only.Await a single reaction in this guild.
pub fn await_reactions<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> ReactionCollectorBuilder<'a>ⓘNotable traits for ReactionCollectorBuilder<'a>
impl<'a> Future for ReactionCollectorBuilder<'a> type Output = ReactionCollector;
[src]
This is supported on crate feature collector
only.
pub fn await_reactions<'a>(
&self,
shard_messenger: &'a impl AsRef<ShardMessenger>
) -> ReactionCollectorBuilder<'a>ⓘNotable traits for ReactionCollectorBuilder<'a>
impl<'a> Future for ReactionCollectorBuilder<'a> type Output = ReactionCollector;
[src]collector
only.Returns a stream builder which can be awaited to obtain a stream of reactions sent in this guild.
pub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
[src]unstable_discord_api
only.Creates a guild specific ApplicationCommand
Note: Unlike global ApplicationCommand
s, guild commands will update instantly.
Errors
Returns the same possible errors as create_global_application_command
.
pub async fn create_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommand>> where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn create_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommand>> where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
[src]unstable_discord_api
only.Same as create_application_command
, but allows to create more
than one command per call.
pub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommandPermission> where
F: FnOnce(&mut CreateApplicationCommandPermissionsData) -> &mut CreateApplicationCommandPermissionsData,
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommandPermission> where
F: FnOnce(&mut CreateApplicationCommandPermissionsData) -> &mut CreateApplicationCommandPermissionsData,
[src]unstable_discord_api
only.Creates a guild specific ApplicationCommandPermission
.
Note: It will update instantly.
pub async fn create_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommandPermission>> where
F: FnOnce(&mut CreateApplicationCommandsPermissions) -> &mut CreateApplicationCommandsPermissions,
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn create_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F
) -> Result<Vec<ApplicationCommandPermission>> where
F: FnOnce(&mut CreateApplicationCommandsPermissions) -> &mut CreateApplicationCommandsPermissions,
[src]unstable_discord_api
only.Same as create_application_command_permission
but allows to create
more than one permission per call.
pub async fn get_application_commands(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommand>>
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn get_application_commands(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommand>>
[src]unstable_discord_api
only.Get all guild application commands.
pub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommand>
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommand>
[src]unstable_discord_api
only.Get a specific guild application command by its Id.
pub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F
) -> Result<ApplicationCommand> where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
[src]unstable_discord_api
only.Edit guild application command by its Id.
pub async fn delete_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<()>
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn delete_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<()>
[src]unstable_discord_api
only.Delete guild application command by its Id.
pub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommandPermission>>
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>
) -> Result<Vec<ApplicationCommandPermission>>
[src]unstable_discord_api
only.Get all guild application commands permissions only.
pub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommandPermission>
[src]
This is supported on crate feature unstable_discord_api
only.
pub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId
) -> Result<ApplicationCommandPermission>
[src]unstable_discord_api
only.Get permissions for specific guild application command by its Id.
pub async fn get_welcome_screen(
&self,
http: impl AsRef<Http>
) -> Result<GuildWelcomeScreen>
[src]
pub async fn get_welcome_screen(
&self,
http: impl AsRef<Http>
) -> Result<GuildWelcomeScreen>
[src]Get the guild welcome screen.
Errors
Returns Error::Http
if the guild does not have a welcome screen.
pub async fn get_preview(&self, http: impl AsRef<Http>) -> Result<GuildPreview>
[src]
pub async fn get_preview(&self, http: impl AsRef<Http>) -> Result<GuildPreview>
[src]Get the guild preview.
Note: The bot need either to be part of the guild
or the guild needs to have the DISCOVERABLE
feature.
Errors
Returns Error::Http
if the bot cannot see the guild preview, see the note.
pub async fn get_widget(&self, http: impl AsRef<Http>) -> Result<GuildWidget>
[src]
pub async fn get_widget(&self, http: impl AsRef<Http>) -> Result<GuildWidget>
[src]Get the guild widget.
Errors
Returns Error::Http
if the bot does not have MANAGE_MESSAGES
permission.
pub fn widget_image_url(&self, style: GuildWidgetStyle) -> String
[src]
pub fn widget_image_url(&self, style: GuildWidgetStyle) -> String
[src]Get the widget image URL.
impl GuildId
[src]
impl GuildId
[src]pub fn created_at(&self) -> DateTime<Utc>
[src]
pub fn created_at(&self) -> DateTime<Utc>
[src]Retrieves the time that the Id was created at.
pub fn as_mut_u64(&mut self) -> &mut u64
[src]
pub fn as_mut_u64(&mut self) -> &mut u64
[src]Mutably borrow inner Id.
Trait Implementations
impl<'de> Deserialize<'de> for GuildId
[src]
impl<'de> Deserialize<'de> for GuildId
[src]fn deserialize<D: Deserializer<'de>>(
deserializer: D
) -> StdResult<Self, D::Error>
[src]
fn deserialize<D: Deserializer<'de>>(
deserializer: D
) -> StdResult<Self, D::Error>
[src]Deserialize this value from the given Serde deserializer. Read more
impl<'a> From<&'a InviteGuild> for GuildId
[src]
impl<'a> From<&'a InviteGuild> for GuildId
[src]fn from(invite_guild: &InviteGuild) -> GuildId
[src]
fn from(invite_guild: &InviteGuild) -> GuildId
[src]Gets the Id of Invite Guild struct.
impl<'a> From<&'a PartialGuild> for GuildId
[src]
impl<'a> From<&'a PartialGuild> for GuildId
[src]fn from(guild: &PartialGuild) -> GuildId
[src]
fn from(guild: &PartialGuild) -> GuildId
[src]Gets the Id of a partial guild.
impl From<GuildId> for GuildContainer
[src]
impl From<GuildId> for GuildContainer
[src]fn from(guild_id: GuildId) -> GuildContainer
[src]
fn from(guild_id: GuildId) -> GuildContainer
[src]Performs the conversion.
impl From<InviteGuild> for GuildId
[src]
impl From<InviteGuild> for GuildId
[src]fn from(invite_guild: InviteGuild) -> GuildId
[src]
fn from(invite_guild: InviteGuild) -> GuildId
[src]Gets the Id of Invite Guild struct.
impl From<PartialGuild> for GuildId
[src]
impl From<PartialGuild> for GuildId
[src]fn from(guild: PartialGuild) -> GuildId
[src]
fn from(guild: PartialGuild) -> GuildId
[src]Gets the Id of a partial guild.
impl Ord for GuildId
[src]
impl Ord for GuildId
[src]impl PartialOrd<GuildId> for GuildId
[src]
impl PartialOrd<GuildId> for GuildId
[src]fn partial_cmp(&self, other: &GuildId) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &GuildId) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for GuildId
[src]
impl Eq for GuildId
[src]
impl StructuralEq for GuildId
[src]
impl StructuralPartialEq for GuildId
[src]
Auto Trait Implementations
impl RefUnwindSafe for GuildId
impl Send for GuildId
impl Sync for GuildId
impl Unpin for GuildId
impl UnwindSafe for GuildId
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<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
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>,
pub fn vzip(self) -> V
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,