Skip to main content

OptionColor

Struct OptionColor 

Source
pub struct OptionColor<COL> {
    pub color: Option<COL>,
}
Expand description

Wrapper for optional color values with style fallback.

This struct provides a convenient way to handle optional color parameters in widgets. When a color is not explicitly set, it falls back to the corresponding color from the global style configuration.

§Type Parameters

  • COL - The pixel color type implementing PixelColor

§Example

use matrix_gui::prelude::*;

// Create with no color set
let mut color = OptionColor::none();

// Set a specific color
color.set_color(Rgb565::RED);

Fields§

§color: Option<COL>

The optional color value.

Implementations§

Source§

impl<COL: PixelColor> OptionColor<COL>

Source

pub const fn none() -> Self

Creates a new OptionColor with no color set.

§Returns

A new OptionColor instance with color set to None.

Source

pub const fn set_color(&mut self, color: COL)

Sets the color value.

§Arguments
  • color - The color to set.
Source

pub fn text_color(&self, style: &Style<COL>) -> COL

Returns the text color, falling back to the style default if not set.

§Arguments
  • style - Reference to the style configuration.
§Returns

The set color if present, otherwise style.text_color.

Source

pub fn background_color(&self, style: &Style<COL>) -> COL

Returns the background color, falling back to the style default if not set.

§Arguments
  • style - Reference to the style configuration.
§Returns

The set color if present, otherwise style.background_color.

Source

pub fn border_color(&self, style: &Style<COL>) -> COL

Returns the border color, falling back to the style default if not set.

§Arguments
  • style - Reference to the style configuration.
§Returns

The set color if present, otherwise style.border_color.

Trait Implementations§

Source§

impl<COL: Debug> Debug for OptionColor<COL>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<COL: PixelColor> From<Option<COL>> for OptionColor<COL>

Converts an Option<COL> into an OptionColor<COL>.

Source§

fn from(color: Option<COL>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<COL> Freeze for OptionColor<COL>
where COL: Freeze,

§

impl<COL> RefUnwindSafe for OptionColor<COL>
where COL: RefUnwindSafe,

§

impl<COL> Send for OptionColor<COL>
where COL: Send,

§

impl<COL> Sync for OptionColor<COL>
where COL: Sync,

§

impl<COL> Unpin for OptionColor<COL>
where COL: Unpin,

§

impl<COL> UnsafeUnpin for OptionColor<COL>
where COL: UnsafeUnpin,

§

impl<COL> UnwindSafe for OptionColor<COL>
where COL: UnwindSafe,

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.