Struct MaterialColor 

pub struct MaterialColor { /* private fields */ }

A colour ramp: one hue in numbered steps, from the palest (50) to the darkest (900), plus the primary step the family is named after.

Accent ramps carry the four steps 100, 200, 400, 700; the grey ramp carries two extra half-steps (350, 850). That is why the steps are a slice rather than a fixed array — a ramp states which steps it has, and MaterialColor::shade answers None for one it does not.

use frus_core::MaterialColor;

assert_eq!(MaterialColor::RED.shade(300), Some(frus_core::Colors::RED_300));
assert_eq!(MaterialColor::RED.shade(350), None); // only grey has the half-steps
assert_eq!(MaterialColor::GREY.shade(350), Some(frus_core::Colors::GREY_350));

Implementations

impl MaterialColor

pub const fn new(primary: Color, shades: &'static [(u16, Color)]) -> Self

Builds a ramp from its primary step and its numbered steps, which must be in ascending order.

pub const fn primary(self) -> Color

The step the family is named after — 500 for a primary ramp, 200 for an accent.

pub fn shade(self, step: u16) -> Option<Color>

The colour at step, or None if this ramp has no such step.

pub fn shade_or_primary(self, step: u16) -> Color

The colour at step, falling back to the primary if the ramp has no such step.

pub fn steps(self) -> impl Iterator<Item = (u16, Color)>

Every (step, colour) pair, in ascending order.

pub fn len(self) -> usize

The number of steps in the ramp.

pub fn is_empty(self) -> bool

Whether the ramp has no steps at all — no bundled family is empty.

impl MaterialColor

pub const RED: MaterialColor

The red ramp: 10 steps, 50 to 900.

pub const PINK: MaterialColor

The pink ramp: 10 steps, 50 to 900.

pub const PURPLE: MaterialColor

The purple ramp: 10 steps, 50 to 900.

pub const DEEP_PURPLE: MaterialColor

The deep purple ramp: 10 steps, 50 to 900.

pub const INDIGO: MaterialColor

The indigo ramp: 10 steps, 50 to 900.

pub const BLUE: MaterialColor

The blue ramp: 10 steps, 50 to 900.

pub const LIGHT_BLUE: MaterialColor

The light blue ramp: 10 steps, 50 to 900.

pub const CYAN: MaterialColor

The cyan ramp: 10 steps, 50 to 900.

pub const TEAL: MaterialColor

The teal ramp: 10 steps, 50 to 900.

pub const GREEN: MaterialColor

The green ramp: 10 steps, 50 to 900.

pub const LIGHT_GREEN: MaterialColor

The light green ramp: 10 steps, 50 to 900.

pub const LIME: MaterialColor

The lime ramp: 10 steps, 50 to 900.

pub const YELLOW: MaterialColor

The yellow ramp: 10 steps, 50 to 900.

pub const AMBER: MaterialColor

The amber ramp: 10 steps, 50 to 900.

pub const ORANGE: MaterialColor

The orange ramp: 10 steps, 50 to 900.

pub const DEEP_ORANGE: MaterialColor

The deep orange ramp: 10 steps, 50 to 900.

pub const BROWN: MaterialColor

The brown ramp: 10 steps, 50 to 900.

pub const GREY: MaterialColor

The grey ramp: 12 steps, 50 to 900.

pub const BLUE_GREY: MaterialColor

The blue grey ramp: 10 steps, 50 to 900.

pub const RED_ACCENT: MaterialColor

The red accent ramp: 4 steps, 100 to 700.

pub const PINK_ACCENT: MaterialColor

The pink accent ramp: 4 steps, 100 to 700.

pub const PURPLE_ACCENT: MaterialColor

The purple accent ramp: 4 steps, 100 to 700.

pub const DEEP_PURPLE_ACCENT: MaterialColor

The deep purple accent ramp: 4 steps, 100 to 700.

pub const INDIGO_ACCENT: MaterialColor

The indigo accent ramp: 4 steps, 100 to 700.

pub const BLUE_ACCENT: MaterialColor

The blue accent ramp: 4 steps, 100 to 700.

pub const LIGHT_BLUE_ACCENT: MaterialColor

The light blue accent ramp: 4 steps, 100 to 700.

pub const CYAN_ACCENT: MaterialColor

The cyan accent ramp: 4 steps, 100 to 700.

pub const TEAL_ACCENT: MaterialColor

The teal accent ramp: 4 steps, 100 to 700.

pub const GREEN_ACCENT: MaterialColor

The green accent ramp: 4 steps, 100 to 700.

pub const LIGHT_GREEN_ACCENT: MaterialColor

The light green accent ramp: 4 steps, 100 to 700.

pub const LIME_ACCENT: MaterialColor

The lime accent ramp: 4 steps, 100 to 700.

pub const YELLOW_ACCENT: MaterialColor

The yellow accent ramp: 4 steps, 100 to 700.

pub const AMBER_ACCENT: MaterialColor

The amber accent ramp: 4 steps, 100 to 700.

pub const ORANGE_ACCENT: MaterialColor

The orange accent ramp: 4 steps, 100 to 700.

pub const DEEP_ORANGE_ACCENT: MaterialColor

The deep orange accent ramp: 4 steps, 100 to 700.

Trait Implementations

impl Clone for MaterialColor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaterialColor

impl Debug for MaterialColor

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

Formats the value using the given formatter.

impl From<MaterialColor> for Color

fn from(ramp: MaterialColor) -> Color

A ramp used where a single colour is expected is its primary step.

impl PartialEq for MaterialColor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MaterialColor