Struct livesplit_core::component::possible_time_save::Component

pub struct Component { /* fields omitted */ }

The Possible Time Save Component is a component that shows how much time the chosen comparison could've saved for the current segment, based on the Best Segments. This component also allows showing the Total Possible Time Save for the remainder of the current attempt.

Methods

impl Component

pub fn new() -> Self

Creates a new Possible Time Save Component.

pub fn with_settings(settings: Settings) -> Self

Creates a new Possible Time Save Component with the given settings.

pub fn settings(&self) -> &Settings

Accesses the settings of the component.

pub fn settings_mut(&mut self) -> &mut Settings

Grants mutable access to the settings of the component.

pub fn name(&self) -> Cow<str>

Accesses the name of the component.

pub fn state(&self, timer: &Timer) -> State

Calculates the component's state based on the timer provided.

pub fn settings_description(&self) -> SettingsDescription

Accesses a generic description of the settings available for this component and their current values.

pub fn set_value(&mut self, index: usize, value: Value)

Sets a setting's value by its index to the given value.

Panics

This panics if the type of the value to be set is not compatible with the type of the setting's value. A panic can also occur if the index of the setting provided is out of bounds.

Trait Implementations

impl From<Component> for Component

fn from(original: Component) -> Component

Performs the conversion.

impl Clone for Component

fn clone(&self) -> Component

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Component

fn default() -> Component

Returns the "default value" for a type.