Struct BackgroundColorMsg 

pub struct BackgroundColorMsg(pub Color);

BackgroundColorMsg represents a background color message. This message is emitted when the program requests the terminal background color with the request_background_color command.

This is commonly used in Model::init to get the terminal background color for style definitions. For that you’ll want to call is_dark() to determine if the color is dark or light. For example:

fn init(&self) -> Cmd { request_background_color() }

fn update(&mut self, msg: Box<dyn Msg>) -> Cmd {
    if let Some(bg) = msg.as_any().downcast_ref::<BackgroundColorMsg>() {
        self.styles = new_styles(bg.is_dark());
    }
    None
}

Tuple Fields

0: Color

Implementations

impl BackgroundColorMsg

pub fn to_hex(&self) -> String

Returns the hex representation of the color.

pub fn is_dark(&self) -> bool

Returns whether the color is dark.

Trait Implementations

impl Clone for BackgroundColorMsg

fn clone(&self) -> BackgroundColorMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BackgroundColorMsg

impl Debug for BackgroundColorMsg

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

Formats the value using the given formatter.

impl Eq for BackgroundColorMsg

impl PartialEq for BackgroundColorMsg

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BackgroundColorMsg