Struct serenity::utils::Colour

pub struct Colour(pub u32);

A utility struct to help with working with the basic representation of a colour. This is particularly useful when working with a Role's colour, as the API works with an integer value instead of an RGB value.

Instances can be created by using the struct's associated functions. These produce presets equivalent to those found in the official client's colour picker.

Examples

Passing in a role's colour, and then retrieving its green component via g:

use serenity::utils::Colour;

// assuming a `role` has already been bound

let green = role.colour.g();

println!("The green component is: {}", green);

Creating an instance with the DARK_TEAL preset:

use serenity::utils::Colour;

let colour = Colour::DARK_TEAL;

assert_eq!(colour.tuple(), (17, 128, 106));

Colours can also be directly compared for equivalence:

use serenity::utils::Colour;

let blitz_blue = Colour::BLITZ_BLUE;
let fooyoo = Colour::FOOYOO;
let fooyoo2 = Colour::FOOYOO;
assert!(blitz_blue != fooyoo);
assert_eq!(fooyoo, fooyoo2);
assert!(blitz_blue > fooyoo);

Methods

impl Colour

pub const fn new(value: u32) -> Colour

Generates a new Colour with the given integer value set.

Examples

Create a new Colour, and then ensure that its inner value is equivalent to a specific RGB value, retrieved via tuple:

use serenity::utils::Colour;

let colour = Colour::new(6573123);

assert_eq!(colour.tuple(), (100, 76, 67));

pub const fn from_rgb(red: u8, green: u8, blue: u8) -> Colour

Generates a new Colour from an RGB value, creating an inner u32 representation.

Examples

Creating a Colour via its RGB values will set its inner u32 correctly:

use serenity::utils::Colour;

assert!(Colour::from_rgb(255, 0, 0).0 == 0xFF0000);
assert!(Colour::from_rgb(217, 23, 211).0 == 0xD917D3);

And you can then retrieve those same RGB values via its methods:

use serenity::utils::Colour;

let colour = Colour::from_rgb(217, 45, 215);

assert_eq!(colour.r(), 217);
assert_eq!(colour.g(), 45);
assert_eq!(colour.b(), 215);
assert_eq!(colour.tuple(), (217, 45, 215));

pub const fn r(self) -> u8

Returns the red RGB component of this Colour.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::new(6573123).r(), 100);

pub const fn g(self) -> u8

Returns the green RGB component of this Colour.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::new(6573123).g(), 76);

pub const fn b(self) -> u8

Returns the blue RGB component of this Colour.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::new(6573123).b(), 67);

pub const fn tuple(self) -> (u8, u8, u8)

Returns a tuple of the red, green, and blue components of this Colour.

This is equivalent to creating a tuple with the return values of r, g, and b.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::new(6573123).tuple(), (100, 76, 67));

pub fn hex(self) -> String

Returns a hexadecimal string of this Colour.

This is equivalent to passing the integer value through std::fmt::UpperHex with 0 padding and 6 width.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::new(6573123).hex(), "644C43");

impl Colour

pub const BLITZ_BLUE: Colour

Creates a new Colour, setting its RGB value to (111, 198, 226).

pub const BLUE: Colour

Creates a new Colour, setting its RGB value to (52, 152, 219).

pub const BLURPLE: Colour

Creates a new Colour, setting its RGB value to (114, 137, 218).

pub const DARK_BLUE: Colour

Creates a new Colour, setting its RGB value to (32, 102, 148).

pub const DARK_GOLD: Colour

Creates a new Colour, setting its RGB value to (194, 124, 14).

pub const DARK_GREEN: Colour

Creates a new Colour, setting its RGB value to (31, 139, 76).

pub const DARK_GREY: Colour

Creates a new Colour, setting its RGB value to (96, 125, 139).

pub const DARK_MAGENTA: Colour

Creates a new Colour, setting its RGB value to (173, 20, 87).

pub const DARK_ORANGE: Colour

Creates a new Colour, setting its RGB value to (168, 67, 0).

pub const DARK_PURPLE: Colour

Creates a new Colour, setting its RGB value to (113, 54, 138).

pub const DARK_RED: Colour

Creates a new Colour, setting its RGB value to (153, 45, 34).

pub const DARK_TEAL: Colour

Creates a new Colour, setting its RGB value to (17, 128, 106).

pub const DARKER_GREY: Colour

Creates a new Colour, setting its RGB value to (84, 110, 122).

pub const FABLED_PINK: Colour

Creates a new Colour, setting its RGB value to (250, 177, 237).

pub const FADED_PURPLE: Colour

Creates a new Colour, setting its RGB value to (136, 130, 196).

pub const FOOYOO: Colour

Creates a new Colour, setting its RGB value to (17, 202, 128).

pub const GOLD: Colour

Creates a new Colour, setting its RGB value to (241, 196, 15).

pub const KERBAL: Colour

Creates a new Colour, setting its RGB value to (186, 218, 85).

pub const LIGHT_GREY: Colour

Creates a new Colour, setting its RGB value to (151, 156, 159).

pub const LIGHTER_GREY: Colour

Creates a new Colour, setting its RGB value to (149, 165, 166).

pub const MAGENTA: Colour

Creates a new Colour, setting its RGB value to (233, 30, 99).

pub const MEIBE_PINK: Colour

Creates a new Colour, setting its RGB value to (230, 131, 151).

pub const ORANGE: Colour

Creates a new Colour, setting its RGB value to (230, 126, 34).

pub const PURPLE: Colour

Creates a new Colour, setting its RGB value to (155, 89, 182).

pub const RED: Colour

Creates a new Colour, setting its RGB value to (231, 76, 60).

pub const ROHRKATZE_BLUE: Colour

Creates a new Colour, setting its RGB value to (117, 150, 255).

pub const ROSEWATER: Colour

Creates a new Colour, setting its RGB value to (246, 219, 216).

pub const TEAL: Colour

Creates a new Colour, setting its RGB value to (26, 188, 156).

Trait Implementations

impl PartialOrd<Colour> for Colour

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

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

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

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

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

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

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

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

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

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

impl PartialEq<Colour> for Colour

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

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

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

This method tests for !=.

impl Copy for Colour

impl Ord for Colour

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for Colour

impl Default for Colour

fn default() -> Colour

Creates a default value for a Colour, setting the inner value to 0.

impl From<i32> for Colour

fn from(value: i32) -> Colour

Constructs a Colour from a i32.

This is used for functions that accept Into<Colour>.

This is useful when providing hex values.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::from(0xDEA584).tuple(), (222, 165, 132));

impl From<u32> for Colour

fn from(value: u32) -> Colour

Constructs a Colour from a u32.

This is used for functions that accept Into<Colour>.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::from(6573123u32).r(), 100);

impl From<u64> for Colour

fn from(value: u64) -> Colour

Constructs a Colour from a u32.

This is used for functions that accept Into<Colour>.

Examples

use serenity::utils::Colour;

assert_eq!(Colour::from(6573123u64).r(), 100);

impl From<(u8, u8, u8)> for Colour

fn from((red, green, blue): (u8, u8, u8)) -> Self

Constructs a Colour from RGB.

impl Clone for Colour

fn clone(&self) -> Colour

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Colour

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

Formats the value using the given formatter.

impl Serialize for Colour

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Colour

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.