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 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 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 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 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 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 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));

impl Colour

pub const BLITZ_BLUE: Colour

BLITZ_BLUE: Colour = Colour(7325410)

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

pub const BLUE: Colour

BLUE: Colour = Colour(3447003)

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

pub const BLURPLE: Colour

BLURPLE: Colour = Colour(7506394)

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

pub const DARK_BLUE: Colour

DARK_BLUE: Colour = Colour(2123412)

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

pub const DARK_GOLD: Colour

DARK_GOLD: Colour = Colour(12745742)

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

pub const DARK_GREEN: Colour

DARK_GREEN: Colour = Colour(2067276)

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

pub const DARK_GREY: Colour

DARK_GREY: Colour = Colour(6323595)

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

pub const DARK_MAGENTA: Colour

DARK_MAGENTA: Colour = Colour(11342935)

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

pub const DARK_ORANGE: Colour

DARK_ORANGE: Colour = Colour(11027200)

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

pub const DARK_PURPLE: Colour

DARK_PURPLE: Colour = Colour(7419530)

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

pub const DARK_RED: Colour

DARK_RED: Colour = Colour(10038562)

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

pub const DARK_TEAL: Colour

DARK_TEAL: Colour = Colour(1146986)

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

pub const DARKER_GREY: Colour

DARKER_GREY: Colour = Colour(5533306)

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

pub const FABLED_PINK: Colour

FABLED_PINK: Colour = Colour(16429549)

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

pub const FADED_PURPLE: Colour

FADED_PURPLE: Colour = Colour(8946372)

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

pub const FOOYOO: Colour

FOOYOO: Colour = Colour(1165952)

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

pub const GOLD: Colour

GOLD: Colour = Colour(15844367)

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

pub const KERBAL: Colour

KERBAL: Colour = Colour(12245589)

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

pub const LIGHT_GREY: Colour

LIGHT_GREY: Colour = Colour(9936031)

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

pub const LIGHTER_GREY: Colour

LIGHTER_GREY: Colour = Colour(9807270)

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

pub const MAGENTA: Colour

MAGENTA: Colour = Colour(15277667)

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

pub const MEIBE_PINK: Colour

MEIBE_PINK: Colour = Colour(15106967)

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

pub const ORANGE: Colour

ORANGE: Colour = Colour(15105570)

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

pub const PURPLE: Colour

PURPLE: Colour = Colour(10181046)

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

pub const RED: Colour

RED: Colour = Colour(15158332)

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

pub const ROHRKATZE_BLUE: Colour

ROHRKATZE_BLUE: Colour = Colour(7706367)

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

pub const ROSEWATER: Colour

ROSEWATER: Colour = Colour(16178136)

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

pub const TEAL: Colour

TEAL: Colour = Colour(1752220)

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

pub fn blitz_blue() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn blue() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn blurple() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_blue() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_gold() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_green() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_grey() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_magenta() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_orange() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_purple() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_red() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn dark_teal() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn darker_grey() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn fabled_pink() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn faded_purple() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn fooyoo() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn gold() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn kerbal() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn light_grey() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn lighter_grey() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn magenta() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn meibe_pink() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn orange() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn purple() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn red() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn rohrkatze_blue() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn rosewater() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

pub fn teal() -> Colour

Deprecated since 0.5.5

: Use the constant instead

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

Trait Implementations

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 Copy for Colour

impl Debug for Colour

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

Formats the value using the given formatter.

impl Eq 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.

impl PartialEq 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 PartialOrd 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 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 Default for Colour

fn default() -> Colour

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