Struct serenity::builder::EditGuild

pub struct EditGuild(pub HashMap<&'static str, Value>);

A builder to optionally edit certain fields of a Guild. This is meant for usage with Guild::edit.

Note: Editing a guild requires that the current user have the Manage Guild permission.

Implementations

impl EditGuild

pub fn afk_channel<C: Into<ChannelId>>(
    &mut self,
    channel: Option<C>
) -> &mut Self

Set the “AFK voice channel” that users are to move to if they have been AFK for an amount of time, configurable by Self::afk_timeout.

The given channel must be either some valid voice channel, or None to not set an AFK channel. The library does not check if a channel is valid.

pub fn afk_timeout(&mut self, timeout: u64) -> &mut Self

Set the amount of time a user is to be moved to the AFK channel - configured via Self::afk_channel - after being AFK.

pub fn icon(&mut self, icon: Option<&str>) -> &mut Self

Set the icon of the guild. Pass None to remove the icon.

Examples

Using the utility function - utils::read_image - to read an image from the cwd and encode it in base64 to send to Discord.

use serenity::utils;

// assuming a `guild` has already been bound

let base64_icon = utils::read_image("./guild_icon.png")?;

guild.edit(&http, |mut g| {
    g.icon(Some(&base64_icon))
})
.await?;

pub fn name<S: ToString>(&mut self, name: S) -> &mut Self

Set the name of the guild.

Note: Must be between (and including) 2-100 chracters.

pub fn description<S: ToString>(&mut self, name: S) -> &mut Self

Set the description of the guild.

Note: Requires that the guild have the DISCOVERABLE feature enabled. You can check this through a guild’s features list.

pub fn features(&mut self, features: Vec<String>) -> &mut Self

Set the features of the guild.

Note: Requires that the guild have the DISCOVERABLE feature enabled. You can check this through a guild’s features list.

pub fn owner<U: Into<UserId>>(&mut self, user_id: U) -> &mut Self

Transfers the ownership of the guild to another user by Id.

Note: The current user must be the owner of the guild.

pub fn region(&mut self, region: Region) -> &mut Self

👎 Deprecated:

Regions are now set per voice channel instead of globally.

Set the voice region of the server.

Examples

Setting the region to Region::UsWest:

use serenity::model::guild::Region;

// assuming a `guild` has already been bound

guild.edit(&http, |g| {
    g.region(Region::UsWest)
})
.await?;

pub fn splash(&mut self, splash: Option<&str>) -> &mut Self

Set the splash image of the guild on the invitation page.

The splash must be base64-encoded 1024x1024 png/jpeg/gif image-data.

Requires that the guild have the INVITE_SPLASH feature enabled. You can check this through a guild’s features list.

pub fn discovery_splash(&mut self, splash: Option<&str>) -> &mut Self

Set the splash image of the guild on the discovery page.

The splash must be base64-encoded 1024x1024 png/jpeg/gif image-data.

Requires that the guild have the DISCOVERABLE feature enabled. You can check this through a guild’s features list.

pub fn banner(&mut self, banner: Option<&str>) -> &mut Self

Set the banner image of the guild, it appears on the left side-bar.

The banner must be base64-encoded 16:9 png/jpeg image data.

Requires that the guild have the BANNER feature enabled. You can check this through a guild’s features list.

pub fn system_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self

Set the channel ID where welcome messages and boost events will be posted.

pub fn rules_channel_id(&mut self, channel_id: Option<ChannelId>) -> &mut Self

Set the channel ID of the rules and guidelines channel.

Note: This feature is for Community guilds only.

pub fn public_updates_channel_id(
    &mut self,
    channel_id: Option<ChannelId>
) -> &mut Self

Set the channel ID where admins and moderators receive update messages from Discord.

Note: This feature is for Community guilds only.

pub fn preferred_locale(&mut self, locale: Option<&str>) -> &mut Self

Set the preferred locale used in Server Discovery and update messages from Discord.

If this is not set, the locale will default to “en-US”;

Note: This feature is for Community guilds only.

pub fn explicit_content_filter(
    &mut self,
    level: Option<ExplicitContentFilter>
) -> &mut Self

Set the content filter level.

pub fn default_message_notifications(
    &mut self,
    level: Option<DefaultMessageNotificationLevel>
) -> &mut Self

Set the default message notification level.

pub fn verification_level<V>(&mut self, verification_level: V) -> &mut Self where
    V: Into<VerificationLevel>, 

Set the verification level of the guild. This can restrict what a user must have prior to being able to send messages in a guild.

Refer to the documentation for VerificationLevel for more information on each variant.

Examples

Setting the verification level to High:

use serenity::model::guild::VerificationLevel;

// assuming a `guild` has already been bound

let edit = guild.edit(&http, |g| {
    g.verification_level(VerificationLevel::High)
})
.await;

if let Err(why) = edit {
    println!("Error setting verification level: {:?}", why);
}

pub fn system_channel_flags(
    &mut self,
    system_channel_flags: SystemChannelFlags
) -> &mut Self

Modifies the notifications that are sent by discord to the configured system channel.

use serenity::model::guild::SystemChannelFlags;

// assuming a `guild` has already been bound

let edit = guild.edit(&http, |g| {
    g.system_channel_flags(SystemChannelFlags::SUPPRESS_JOIN_NOTIFICATIONS | SystemChannelFlags::SUPPRESS_GUILD_REMINDER_NOTIFICATIONS)
})
.await;

if let Err(why) = edit {
    println!("Error setting verification level: {:?}", why);
}

Trait Implementations

impl Clone for EditGuild

fn clone(&self) -> EditGuild

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EditGuild

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

Formats the value using the given formatter.

impl Default for EditGuild

fn default() -> EditGuild

Returns the “default value” for a type.