Struct livesplit_core::HotkeyConfig

pub struct HotkeyConfig {
    pub split: Option<KeyCode>,
    pub reset: Option<KeyCode>,
    pub undo: Option<KeyCode>,
    pub skip: Option<KeyCode>,
    pub pause: Option<KeyCode>,
    pub undo_all_pauses: Option<KeyCode>,
    pub previous_comparison: Option<KeyCode>,
    pub next_comparison: Option<KeyCode>,
    pub toggle_timing_method: Option<KeyCode>,
}

The configuration to use for a Hotkey System. It describes with keys to use as hotkeys for the different actions.

Fields

split: Option<KeyCode>

The key to use for splitting and starting a new attempt.

reset: Option<KeyCode>

The key to use for resetting the current attempt.

undo: Option<KeyCode>

The key to use for undoing the last split.

skip: Option<KeyCode>

The key to use for skipping the current split.

pause: Option<KeyCode>

The key to use for pausing the current attempt and starting a new attempt.

undo_all_pauses: Option<KeyCode>

The key to use for removing all the pause times from the current time.

previous_comparison: Option<KeyCode>

The key to use for switching to the previous comparison.

next_comparison: Option<KeyCode>

The key to use for switching to the next comparison.

toggle_timing_method: Option<KeyCode>

The key to use for toggling between the Real Time and Game Time timing methods.

Methods

impl HotkeyConfig

pub fn settings_description(&self) -> SettingsDescription

Accesses a generic description of the settings available for the hotkey configuration and their current values.

pub fn set_value(&mut self, index: usize, value: Value) -> Result<(), ()>

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

Errors

An error is returned if a hotkey is already in use by a different action.

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.

pub fn from_json<R>(reader: R) -> Result<Self> where
    R: Read, 

Decodes the hotkey configuration from JSON.

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

Encodes the hotkey configuration as JSON.

Trait Implementations

impl Copy for HotkeyConfig

impl PartialEq<HotkeyConfig> for HotkeyConfig

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

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

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

This method tests for !=.

impl Clone for HotkeyConfig

fn clone(&self) -> HotkeyConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for HotkeyConfig

impl Default for HotkeyConfig

fn default() -> Self

Returns the "default value" for a type.

impl Debug for HotkeyConfig

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

Formats the value using the given formatter.

impl Hash for HotkeyConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Serialize for HotkeyConfig

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 HotkeyConfig where
    HotkeyConfig: Default, 

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

Deserialize this value from the given Serde deserializer.