Struct livesplit_core::component::splits::State

pub struct State {
    pub background: ListGradient,
    pub column_labels: Option<Vec<String>>,
    pub splits: Vec<SplitState>,
    pub icon_changes: Vec<IconChange>,
    pub has_icons: bool,
    pub show_thin_separators: bool,
    pub show_final_separator: bool,
    pub display_two_rows: bool,
    pub current_split_gradient: Gradient,
}

The state object describes the information to visualize for this component.

Fields

background: ListGradient

The background shown behind the splits.

column_labels: Option<Vec<String>>

The column labels to visualize about the list of splits. If this is None, no labels are supposed to be visualized. The list is specified from right to left.

splits: Vec<SplitState>

The list of all the segments to visualize.

icon_changes: Vec<IconChange>

This list describes all the icon changes that happened. Each time a segment is first shown or its icon changes, the new icon is provided in this list. If necessary, you may remount this component to reset the component into a state where these icons are provided again.

has_icons: bool

Specifies whether the current run has any icons, even those that are not currently visible by the splits component. This allows for properly indenting the icon column, even when the icons are scrolled outside the splits component.

show_thin_separators: bool

Specifies whether thin separators should be shown between the individual segments shown by the component.

show_final_separator: bool

Describes whether a more pronounced separator should be shown in front of the last segment provided.

display_two_rows: bool

Specifies whether to display each split as two rows, with the segment name being in one row and the times being in the other.

current_split_gradient: Gradient

The gradient to show behind the current segment as an indicator of it being the current segment.

Methods

impl State

pub fn write_json<W>(&self, writer: W) -> Result<()> where
    W: Write, 

Encodes the state object's information as JSON.

Trait Implementations

impl Debug for State

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

Formats the value using the given formatter.

impl Serialize for State

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 State

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

Deserialize this value from the given Serde deserializer.