Struct genie_hki::HotkeyInfoMetadata

pub struct HotkeyInfoMetadata(_);

A list of information about hotkey groups in a hotkey file. The length is the number of groups in the file. Each StringKey in the list is the key of the string that names the group. The key is stored at the group's offset index in the hotkey file.

Implementations

impl HotkeyInfoMetadata

pub fn new() -> Self

Returns an empty HotkeyInfoMetadata struct.

Examples

use genie_hki::HotkeyInfoMetadata;

let him = HotkeyInfoMetadata::new();

pub fn add(&mut self, sk: StringKey)

Adds a group to the metadata.

Examples

use genie_hki::HotkeyInfoMetadata;
use genie_lang::StringKey;

let mut him = HotkeyInfoMetadata::new();
him.add(StringKey::from(0u32));

pub fn len(&self) -> usize

Returns the number of groups described by this metadata.

Examples

use genie_hki::HotkeyInfoMetadata;
use genie_lang::StringKey;

let mut him = HotkeyInfoMetadata::new();
assert_eq!(0, him.len());
him.add(StringKey::from(0u32));
assert_eq!(1, him.len());

pub fn is_empty(&self) -> bool

Returns true if this metadata does not contain any groups.

Examples

use genie_hki::HotkeyInfoMetadata;
use genie_lang::StringKey;

let mut him = HotkeyInfoMetadata::new();
assert!(him.is_empty());
him.add(StringKey::from(0u32));
assert!(!him.is_empty());

pub fn get(&self, index: usize) -> Option<&StringKey>

Returns Some(sk), where sk is the string key of the group at the given index. Returns None if no group is located at index, that is, if index >= self.len().

Examples

use genie_hki::HotkeyInfoMetadata;
use genie_lang::StringKey;

let mut him = HotkeyInfoMetadata::new();
assert_eq!(None, him.get(0));
him.add(StringKey::from(0u32));
assert_eq!(Some(&StringKey::from(0u32)), him.get(0));

pub fn iter(&self) -> impl Iterator<Item = &StringKey>

Returns an iterator over the hotkey group metadata contained in this hotkey file's data.

Examples

use genie_hki::HotkeyInfoMetadata;
use genie_lang::StringKey;

let mut him = HotkeyInfoMetadata::new();
him.add(StringKey::from(0u32));
him.add(StringKey::from(1u32));
let mut iter = him.iter();
assert_eq!(Some(&StringKey::from(0u32)), iter.next());
assert_eq!(Some(&StringKey::from(1u32)), iter.next());
assert_eq!(None, iter.next());

Trait Implementations

impl Clone for HotkeyInfoMetadata

fn clone(&self) -> HotkeyInfoMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HotkeyInfoMetadata

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

Formats the value using the given formatter.

impl Default for HotkeyInfoMetadata

fn default() -> HotkeyInfoMetadata

Returns the "default value" for a type.

impl Eq for HotkeyInfoMetadata

impl From<Vec<StringKey>> for HotkeyInfoMetadata

fn from(sks: Vec<StringKey>) -> Self

Performs the conversion.

impl IntoIterator for HotkeyInfoMetadata

type Item = StringKey

The type of the elements being iterated over.

type IntoIter = IntoIter<StringKey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a HotkeyInfoMetadata

type Item = &'a StringKey

The type of the elements being iterated over.

type IntoIter = Iter<'a, StringKey>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<HotkeyInfoMetadata> for HotkeyInfoMetadata

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

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

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

This method tests for !=.

impl StructuralEq for HotkeyInfoMetadata

impl StructuralPartialEq for HotkeyInfoMetadata