use internal::prelude::*; use model::{ guild::Role, Permissions }; use utils::VecMap; /// A builder to create or edit a [`Role`] for use via a number of model methods. /// /// These are: /// /// - [`PartialGuild::create_role`] /// - [`Guild::create_role`] /// - [`Guild::edit_role`] /// - [`GuildId::create_role`] /// - [`GuildId::edit_role`] /// - [`Role::edit`] /// /// Defaults are provided for each parameter on role creation. /// /// # Examples /// /// Create a hoisted, mentionable role named `"a test role"`: /// /// ```rust,no_run /// # use serenity::model::id::{ChannelId, GuildId}; /// # let (channel_id, guild_id) = (ChannelId(1), GuildId(2)); /// # /// // assuming a `channel_id` and `guild_id` has been bound /// /// let role = guild_id.create_role(|r| r /// .hoist(true) /// .mentionable(true) /// .name("a test role")); /// ``` /// /// [`PartialGuild::create_role`]: ../model/guild/struct.PartialGuild.html#method.create_role /// [`Guild::create_role`]: ../model/guild/struct.Guild.html#method.create_role /// [`Guild::edit_role`]: ../model/guild/struct.Guild.html#method.edit_role /// [`GuildId::create_role`]: ../model/id/struct.GuildId.html#method.create_role /// [`GuildId::edit_role`]: ../model/id/struct.GuildId.html#method.edit_role /// [`Role`]: ../model/guild/struct.Role.html /// [`Role::edit`]: ../model/guild/struct.Role.html#method.edit #[derive(Clone, Debug, Default)] pub struct EditRole(pub VecMap<&'static str, Value>); impl EditRole { /// Creates a new builder with the values of the given [`Role`]. /// /// [`Role`]: ../model/guild/struct.Role.html pub fn new(role: &Role) -> Self { let mut map = VecMap::with_capacity(8); #[cfg(feature = "utils")] { map.insert("color", Value::Number(Number::from(role.colour.0))); } #[cfg(not(feature = "utils"))] { map.insert("color", Value::Number(Number::from(role.colour))); } map.insert("hoist", Value::Bool(role.hoist)); map.insert("managed", Value::Bool(role.managed)); map.insert("mentionable", Value::Bool(role.mentionable)); map.insert("name", Value::String(role.name.clone())); map.insert("permissions",Value::Number(Number::from(role.permissions.bits()))); map.insert("position", Value::Number(Number::from(role.position))); EditRole(map) } /// Sets the colour of the role. pub fn colour(mut self, colour: u64) -> Self { self.0.insert("color", Value::Number(Number::from(colour))); self } /// Whether or not to hoist the role above lower-positioned role in the user /// list. pub fn hoist(mut self, hoist: bool) -> Self { self.0.insert("hoist", Value::Bool(hoist)); self } /// Whether or not to make the role mentionable, notifying its users. pub fn mentionable(mut self, mentionable: bool) -> Self { self.0.insert("mentionable", Value::Bool(mentionable)); self } /// The name of the role to set. pub fn name(mut self, name: &str) -> Self { self.0 .insert("name", Value::String(name.to_string())); self } /// The set of permissions to assign the role. pub fn permissions(mut self, permissions: Permissions) -> Self { self.0.insert("permissions", Value::Number(Number::from(permissions.bits()))); self } /// The position to assign the role in the role list. This correlates to the /// role's position in the user list. pub fn position(mut self, position: u8) -> Self { self.0.insert("position", Value::Number(Number::from(position))); self } }