Struct serenity::model::id::GuildId

pub struct GuildId(pub u64);

An identifier for a Guild

Implementations

impl GuildId

pub fn ban<U, BO>(
    self,
    http: impl AsRef<Http>,
    user: U,
    ban_options: &BO
) -> Result<()> where
    U: Into<UserId>,
    BO: BanOptions, 

Ban a User from the guild. All messages by the user within the last given number of days given will be deleted.

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::GuildId;

// assuming a `user` has already been bound
let _ = GuildId(81384788765712384).ban(user, 4);

Errors

Returns a ModelError::DeleteMessageDaysAmount if the number of days' worth of messages to delete is over the maximum.

pub fn bans(self, http: impl AsRef<Http>) -> Result<Vec<Ban>>

Gets a list of the guild's bans.

Requires the Ban Members permission.

pub fn audit_logs(
    self,
    http: impl AsRef<Http>,
    action_type: Option<u8>,
    user_id: Option<UserId>,
    before: Option<AuditLogEntryId>,
    limit: Option<u8>
) -> Result<AuditLogs>

Gets a list of the guild's audit log entries

pub fn channels(
    self,
    http: impl AsRef<Http>
) -> Result<HashMap<ChannelId, GuildChannel>>

Gets all of the guild's channels over the REST API.

pub fn create_channel(
    self,
    http: impl AsRef<Http>,
    f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel
) -> Result<GuildChannel>

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(|c| c.name("test").kind(ChannelType::Voice));

pub fn create_emoji(
    self,
    http: impl AsRef<Http>,
    name: &str,
    image: &str
) -> Result<Emoji>

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.

pub fn create_integration<I>(
    self,
    http: impl AsRef<Http>,
    integration_id: I,
    kind: &str
) -> Result<()> where
    I: Into<IntegrationId>, 

Creates an integration for the guild.

Requires the Manage Guild permission.

pub fn create_role<F>(self, http: impl AsRef<Http>, f: F) -> Result<Role> where
    F: FnOnce(&mut EditRole) -> &mut EditRole, 

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.

pub fn delete(self, http: impl AsRef<Http>) -> Result<PartialGuild>

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.

pub fn delete_emoji<E: Into<EmojiId>>(
    self,
    http: impl AsRef<Http>,
    emoji_id: E
) -> Result<()>

Deletes an Emoji from the guild.

Requires the Manage Emojis permission.

pub fn delete_integration<I: Into<IntegrationId>>(
    self,
    http: impl AsRef<Http>,
    integration_id: I
) -> Result<()>

Deletes an integration by Id from the guild.

Requires the Manage Guild permission.

pub fn delete_role<R: Into<RoleId>>(
    self,
    http: impl AsRef<Http>,
    role_id: R
) -> Result<()>

Deletes a Role by Id from the guild.

Also see Role::delete if you have the cache and methods features enabled.

Requires the Manage Roles permission.

pub fn edit<F>(&mut self, http: impl AsRef<Http>, f: F) -> Result<PartialGuild> where
    F: FnOnce(&mut EditGuild) -> &mut EditGuild, 

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.

pub fn edit_emoji<E: Into<EmojiId>>(
    self,
    http: impl AsRef<Http>,
    emoji_id: E,
    name: &str
) -> Result<Emoji>

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.

pub fn edit_member<F, U>(
    self,
    http: impl AsRef<Http>,
    user_id: U,
    f: F
) -> Result<()> where
    F: FnOnce(&mut EditMember) -> &mut EditMember,
    U: Into<UserId>, 

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]));

pub fn edit_nickname(
    self,
    http: impl AsRef<Http>,
    new_nickname: Option<&str>
) -> Result<()>

Edits the current user's nickname for the guild.

Pass None to reset the nickname.

Requires the Change Nickname permission.

pub fn edit_role<F, R>(
    self,
    http: impl AsRef<Http>,
    role_id: R,
    f: F
) -> Result<Role> where
    F: FnOnce(&mut EditRole) -> &mut EditRole,
    R: Into<RoleId>, 

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));

pub fn edit_role_position<R>(
    self,
    http: impl AsRef<Http>,
    role_id: R,
    position: u64
) -> Result<Vec<Role>> where
    R: Into<RoleId>, 

Edits the order of Roles 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);

pub fn to_guild_cached(
    self,
    cache: impl AsRef<CacheRwLock>
) -> Option<Arc<RwLock<Guild>>>

Tries to find the Guild by its Id in the cache.

pub fn to_partial_guild(self, http: impl AsRef<Http>) -> Result<PartialGuild>

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.

pub fn integrations(self, http: impl AsRef<Http>) -> Result<Vec<Integration>>

Gets all integration of the guild.

This performs a request over the REST API.

pub fn invites(self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>>

Gets all of the guild's invites.

Requires the Manage Guild permission.

pub fn kick<U: Into<UserId>>(
    self,
    http: impl AsRef<Http>,
    user_id: U
) -> Result<()>

Kicks a Member from the guild.

Requires the Kick Members permission.

pub fn kick_with_reason<U: Into<UserId>>(
    self,
    http: impl AsRef<Http>,
    user_id: U,
    reason: &str
) -> Result<()>

pub fn leave(self, http: impl AsRef<Http>) -> Result<()>

Leaves the guild.

pub fn member<U: Into<UserId>>(
    self,
    cache_http: impl CacheHttp,
    user_id: U
) -> Result<Member>

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.

pub fn members<U>(
    self,
    http: impl AsRef<Http>,
    limit: Option<u64>,
    after: U
) -> Result<Vec<Member>> where
    U: Into<Option<UserId>>, 

Gets a list of the guild's members.

Optionally pass in the limit to limit the number of results. Maximum value is 1000. Optionally pass in after to offset the results by a User's Id.

pub fn members_iter<H: AsRef<Http>>(self, http: H) -> MembersIter<H>

Iterates over all the members in a guild.

This is accomplished and equivilent to repeated calls to [members]. A buffer of at most 1,000 members is used to reduce the number of calls necessary.

Examples

for member_result in guild_id.members_iter(&ctx) {
    match member_result {
        Ok(member) => println!(
            "{} is {}",
            member,
            member.display_name()
        ),
        Err(error) => eprintln!("Uh oh!  Error: {}", error),
    }
}

pub fn move_member<C, U>(
    self,
    http: impl AsRef<Http>,
    user_id: U,
    channel_id: C
) -> Result<()> where
    C: Into<ChannelId>,
    U: Into<UserId>, 

Moves a member to a specific voice channel.

Requires the Move Members permission.

pub fn prune_count(
    self,
    http: impl AsRef<Http>,
    days: u16
) -> Result<GuildPrune>

Gets the number of Members that would be pruned with the given number of days.

Requires the Kick Members permission.

pub fn reorder_channels<It>(
    self,
    http: impl AsRef<Http>,
    channels: It
) -> Result<()> where
    It: IntoIterator<Item = (ChannelId, u64)>, 

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.

pub fn shard_id(self, cache: impl AsRef<CacheRwLock>) -> u64

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 fn start_integration_sync<I: Into<IntegrationId>>(
    self,
    http: impl AsRef<Http>,
    integration_id: I
) -> Result<()>

Starts an integration sync for the given integration Id.

Requires the Manage Guild permission.

pub fn start_prune(
    self,
    http: impl AsRef<Http>,
    days: u16
) -> Result<GuildPrune>

Starts a prune of Members.

See the documentation on GuildPrune for more information.

Note: Requires the Kick Members permission.

pub fn unban<U: Into<UserId>>(
    self,
    http: impl AsRef<Http>,
    user_id: U
) -> Result<()>

Unbans a User from the guild.

Requires the Ban Members permission.

pub fn vanity_url(self, http: impl AsRef<Http>) -> Result<String>

Retrieve's the guild's vanity URL.

Note: Requires the Manage Guild permission.

pub fn webhooks(self, http: impl AsRef<Http>) -> Result<Vec<Webhook>>

Retrieves the guild's webhooks.

Note: Requires the Manage Webhooks permission.

impl GuildId

pub fn created_at(&self) -> DateTime<FixedOffset>

Retrieves the time that the Id was created at.

pub fn as_u64(&self) -> &u64

Immutably borrow inner Id.

pub fn as_mut_u64(&mut self) -> &mut u64

Mutably borrow inner Id.

Trait Implementations

impl AsRef<GuildId> for GuildId

pub fn as_ref(&self) -> &Self

Performs the conversion.

impl Clone for GuildId

pub fn clone(&self) -> GuildId

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for GuildId

impl Debug for GuildId

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GuildId

pub fn default() -> GuildId

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for GuildId

pub fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> StdResult<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for GuildId

pub fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl Eq for GuildId

impl<'a> From<&'a Guild> for GuildId

pub fn from(live_guild: &Guild) -> GuildId

Gets the Id of Guild.

impl<'a> From<&'a GuildId> for GuildId

pub fn from(id: &'a GuildId) -> GuildId

Performs the conversion.

impl<'a> From<&'a GuildInfo> for GuildId

pub fn from(guild_info: &GuildInfo) -> GuildId

Gets the Id of Guild information struct.

impl<'a> From<&'a InviteGuild> for GuildId

pub fn from(invite_guild: &InviteGuild) -> GuildId

Gets the Id of Invite Guild struct.

impl<'a> From<&'a PartialGuild> for GuildId

pub fn from(guild: &PartialGuild) -> GuildId

Gets the Id of a partial guild.

impl From<Guild> for GuildId

pub fn from(live_guild: Guild) -> GuildId

Gets the Id of Guild.

impl From<GuildId> for GuildContainer

pub fn from(guild_id: GuildId) -> GuildContainer

Performs the conversion.

impl From<GuildId> for u64

pub fn from(id: GuildId) -> u64

Performs the conversion.

impl From<GuildId> for i64

pub fn from(id: GuildId) -> i64

Performs the conversion.

impl From<GuildInfo> for GuildId

pub fn from(guild_info: GuildInfo) -> GuildId

Gets the Id of Guild information struct.

impl From<InviteGuild> for GuildId

pub fn from(invite_guild: InviteGuild) -> GuildId

Gets the Id of Invite Guild struct.

impl From<PartialGuild> for GuildId

pub fn from(guild: PartialGuild) -> GuildId

Gets the Id of a partial guild.

impl From<u64> for GuildId

pub fn from(id_as_u64: u64) -> GuildId

Performs the conversion.

impl Hash for GuildId

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for GuildId

pub fn cmp(&self, other: &GuildId) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GuildId> for GuildId

pub fn eq(&self, other: &GuildId) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &GuildId) -> bool

This method tests for !=.

impl PartialEq<u64> for GuildId

pub fn eq(&self, u: &u64) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<GuildId> for GuildId

pub fn partial_cmp(&self, other: &GuildId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &GuildId) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &GuildId) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &GuildId) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &GuildId) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GuildId

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for GuildId

impl StructuralPartialEq for GuildId