Enum Color

pub enum Color {
    Black,
    DarkBlue,
    DarkGreen,
    DarkAqua,
    DarkRed,
    DarkPurple,
    Gold,
    Gray,
    DarkGray,
    Blue,
    Green,
    Aqua,
    Red,
    LightPurple,
    Yellow,
    White,
}

Various colors that a Span can have.

See the wiki.vg docs for specific information.

Variants

Black

DarkBlue

DarkGreen

DarkAqua

DarkRed

DarkPurple

Gold

Gray

DarkGray

Blue

Green

Aqua

Red

LightPurple

Yellow

White

Implementations

impl Color

pub fn from_char(c: char) -> Option<Self>

Map a char to a Color.

Returns None if c didn’t map to a Color.

pub const fn foreground_hex_str(&self) -> &'static str

Get the correct foreground hex color string for a given color

Examples

use mc_legacy_formatting::Color;
assert_eq!(Color::Aqua.foreground_hex_str(), "#55ffff");

pub const fn background_hex_str(&self) -> &'static str

Get the correct background hex color string for a given color

Examples

use mc_legacy_formatting::Color;
assert_eq!(Color::Aqua.background_hex_str(), "#153f3f");

pub const fn foreground_rgb(&self) -> (u8, u8, u8)

Get the correct foreground RGB color values for a given color

Returns (red, green, blue)

Examples

use mc_legacy_formatting::Color;
assert_eq!(Color::Aqua.foreground_rgb(), (85, 255, 255));

pub const fn background_rgb(&self) -> (u8, u8, u8)

Get the correct background RGB color values for a given color

Returns (red, green, blue)

Examples

use mc_legacy_formatting::Color;
assert_eq!(Color::Aqua.background_rgb(), (21, 63, 63));

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Default for Color

fn default() -> Self

Returns the “default value” for a type.

impl From<Color> for Color

fn from(c: Color) -> Self

Converts to this type from the input type.

impl Hash for Color

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Color

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Color

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Color

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Color

impl Eq for Color

impl StructuralPartialEq for Color