Skip to main content

Color

Struct Color 

Source
pub struct Color { /* private fields */ }
Expand description

This represents an RGB color, stored as it’s individual color values and it’s hexadecimal string

Implementations§

Source§

impl Color

Source

pub fn rgb(r: u8, g: u8, b: u8) -> Self

Create a new Color from a red color value, a green color value and a blue color value

Source

pub fn from_color_string(string: &str) -> Result<Self, Error>

Create a new Color from a color name. This will result in an error if the color name isn’t recognized

§recognized names
  • red => (255, 0, 0)
  • green => (0, 255, 0)
  • blue => (0, 0, 255)
  • white => (255, 255, 255)
  • black => (0, 0, 0)
  • yellow => (255, 255 ,0)
  • purple => (255, 0, 255)
  • cyan => (0, 255, 255)
Source

pub fn from_rgb_string(string: &str) -> Result<Self, Error>

Create a new Color from a string slice formatted this way : “(r,g,b)” - “()” are necessary - Each value must be seperated by a comma - Each value must be at most 255 - whitespace is irrelevant This will result in an error if the string cannot be parsed

Source

pub fn from_hexadecimal(hexadecimal_color: &str) -> Result<Self, FromHexError>

Create a new Color from a string slice representing an hexadecimal value - The number of ‘#’ at the start of the slice is irrelevant - The slice must contain exactly 6 hexadecimal digits (ignoring ‘#’) - The casing of the hexadecimal value is irrelevant

§[API note]
  • This makes use of the hex crate
Source

pub fn red(&self) -> u8

Returns the red value of the color

Source

pub fn green(&self) -> u8

Returns the green value of the color

Source

pub fn blue(&self) -> u8

Returns the blue value of the color

Source

pub fn hexadecimal_value(&self) -> String

Returns the hexadecimal value of the color

Source

pub fn inverted(&self) -> Self

Returns the inverted variant of the color

Trait Implementations§

Source§

impl Clone for Color

Source§

fn clone(&self) -> Color

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Color

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Color

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnsafeUnpin for Color

§

impl UnwindSafe for Color

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.