Struct genie_hki::HotkeyInfo

pub struct HotkeyInfo { /* fields omitted */ }

Represents a HKI file containing hotkey settings.

Methods

impl HotkeyInfo

pub fn from<R: Read>(input: &mut R) -> Result<Self>

Read a hotkey info file.

pub fn write_to<W: Write>(&self, output: &mut W) -> Result<()>

Write a hotkey info file.

pub fn version(&self) -> f32

Get the file version.

use std::fs::File;
use genie_hki::HotkeyInfo;
let mut f = File::open("test/files/aoc1.hki").unwrap();
let info = HotkeyInfo::from(&mut f).expect("failed to read file");
assert_eq!(info.version(), 1.0);

let mut f = File::open("test/files/hd0.hki").unwrap();
let info = HotkeyInfo::from(&mut f).expect("failed to read file");
assert_eq!(info.version(), 3.0);

pub fn group(&self, group_id: HotkeyGroupId) -> Option<&HotkeyGroup>

Get a hotkey group. Groups may not exist in every file.

use std::fs::File;
use genie_hki::{HotkeyInfo, HotkeyGroupId};
let mut f = File::open("test/files/aoc1.hki").unwrap();
let info = HotkeyInfo::from(&mut f).expect("failed to read file");
assert!(info.group(HotkeyGroupId::Villager).is_some());
assert!(info.group(HotkeyGroupId::Mill).is_none());

pub fn group_mut(&mut self, group_id: HotkeyGroupId) -> Option<&mut HotkeyGroup>

Trait Implementations

impl Clone for HotkeyInfo

fn clone(&self) -> HotkeyInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HotkeyInfo

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

Formats the value using the given formatter.