Struct RoleFieldsBuilder

pub struct RoleFieldsBuilder(/* private fields */);

A builder for role fields.

Implementations

impl RoleFieldsBuilder

pub const COLOR_MAXIMUM: u32 = 16_777_215u32

The maximum accepted color value.

This is used by color.

pub const fn new(name: String) -> Self

Create a new default role field builder.

pub fn build(self) -> Result<RoleFields, RoleFieldsError>

Build the role fields.

Errors

Returns a RoleFieldsErrorType::ColorNotRgb error type if the color is not valid RGB.

pub fn color(self, color: u32) -> Self

Set the role color.

This must be a valid hexadecimal RGB value. 0x000000 is ignored and doesn’t count towards the final computed color in the user list. Refer to Self::COLOR_MAXIMUM for the maximum acceptable value.

pub fn hoist(self) -> Self

Show the role above other roles in the user list.

pub fn id(self, id: Id<RoleMarker>) -> Self

Set the id of the role.

Errors

Returns a RoleFieldsErrorType::IdInvalid error type if the ID is set to 1.

pub fn mentionable(self) -> Self

Allow the role to be @mentioned.

pub fn permissions(self, permissions: Permissions) -> Self

Set the permissions of the role.

pub fn position(self, position: i64) -> Self

Set the position of the role.

Trait Implementations

impl Debug for RoleFieldsBuilder

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

Formats the value using the given formatter.