Struct serenity::model::Member

pub struct Member {
    pub deaf: bool,
    pub joined_at: String,
    pub mute: bool,
    pub nick: Option<String>,
    pub roles: Vec<RoleId>,
    pub user: User,
}

Represents information about a member of a guild.

Fields

deaf: bool

True if user isn't allowed to hear in voice channels.

joined_at: String

Timestamp representing the date when the member joined.

mute: bool

True if user isn't allowed to talk in voice channels.

nick: Option<String>

Optional nickname. Can't be longer than 32 characters.

roles: Vec<RoleId>

Ids of roles that were given to the member.

user: User

Attached User struct.

Methods

impl Member

fn add_role<R: Into<RoleId>>(&mut self, role_id: R) -> Result<()>

Adds a Role to the member, editing its roles in-place if the request was successful.

Note: Requires the Manage Roles permission.

fn add_roles(&mut self, role_ids: &[RoleId]) -> Result<()>

Adds one or multiple Roles to the member, editing its roles in-place if the request was successful.

Note: Requires the Manage Roles permission.

fn ban(&self, delete_message_days: u8) -> Result<()>

Ban the member from its guild, deleting the last X number of days' worth of messages.

Note: Requires the Ban Members role.

Errors

Returns a ClientError::GuildNotFound if the guild could not be found.

fn colour(&self) -> Option<Colour>

Determines the member's colour.

fn display_name(&self) -> &str

Calculates the member's display name.

The nickname takes priority over the member's username if it exists.

fn distinct(&self) -> String

Returns the DiscordTag of a Member, taking possible nickname into account.

fn edit<F: FnOnce(EditMember) -> EditMember>(&self, f: F) -> Result<()>

Edits the member with the given data. See Context::edit_member for more information.

See EditMember for the permission(s) required for separate builder methods, as well as usage of this.

fn find_guild(&self) -> Result<GuildId>

Finds the Id of the Guild that the member is in.

Errors

Returns a ClientError::GuildNotFound if the guild could not be found.

fn remove_role<R: Into<RoleId>>(&mut self, role_id: R) -> Result<()>

Removes a Role from the member, editing its roles in-place if the request was successful.

Note: Requires the Manage Roles permission.

fn remove_roles(&mut self, role_ids: &[RoleId]) -> Result<()>

Removes one or multiple Roles from the member.

Note: Requires the Manage Roles permission.

fn roles(&self) -> Option<Vec<Role>>

Retrieves the full role data for the user's roles.

This is shorthand for manually searching through the CACHE.

If role data can not be found for the member, then None is returned.

fn unban(&self) -> Result<()>

Unbans the User from the guild.

Note: Requires the Ban Members permission.

Errors

If the cache is enabled, returns a ClientError::InvalidPermissions if the current user does not have permission to perform bans.

Trait Implementations

impl Display for Member

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

Mentions the user so that they receive a notification.

Examples

// assumes a `member` has already been bound
println!("{} is a member!", member);

impl Mentionable for Member

fn mention(&self) -> String

impl Clone for Member

fn clone(&self) -> Member

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Member

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.