Enum livesplit_core::settings::SemanticColor

pub enum SemanticColor {
    Default,
    AheadGainingTime,
    AheadLosingTime,
    BehindLosingTime,
    BehindGainingTime,
    BestSegment,
    NotRunning,
    Paused,
    PersonalBest,
}

A Semantic Color describes a color by some meaningful event that is happening. This information can be visualized as a color, but can also be interpreted in other ways by the consumer of this API.

Variants

Default

There's no meaningful information for this color.

AheadGainingTime

The runner is ahead of the comparison and is gaining even more time.

AheadLosingTime

The runner is ahead of the comparison, but is losing time.

BehindLosingTime

The runner is behind the comparison and is losing even more time.

BehindGainingTime

The runner is behind the comparison, but is gaining back time.

BestSegment

The runner achieved a best segment.

NotRunning

There's no active attempt.

Paused

The timer is paused.

PersonalBest

The runner achieved a new Personal Best.

Methods

impl SemanticColor

pub fn or(self, color: SemanticColor) -> SemanticColor

Replaces a Semantic Color by the Semantic Color provided if it is the default one.

pub fn visualize(self, settings: &GeneralSettings) -> Color

The General Settings store actual Color values for each of the different events. Using this method, you can use these to convert a Semantic Color to an actual Color.

Trait Implementations

impl Copy for SemanticColor

impl PartialEq<SemanticColor> for SemanticColor

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Eq for SemanticColor

impl Clone for SemanticColor

fn clone(&self) -> SemanticColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SemanticColor

fn default() -> SemanticColor

Returns the "default value" for a type.

impl Debug for SemanticColor

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

Formats the value using the given formatter.

impl Serialize for SemanticColor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SemanticColor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.