Crate stenotype

Utilities for machine stenography

Feature Flags

• json (enabled by default) — Support for parsing json steno dictionaries
• engine (enabled by default) — Enable the steno engine that translates strokes into text - ⚠️ WIP
• protocols (enabled by default) — Provide protocols communicating for various steno machines
• std (enabled by default) — Provide functionality that requires the std library

Modules

engine

Translates strokes into text using a dictionary

protocols

Protocols for various steno machines

Structs

Dictionary

Implements a Dict as a simple in-memory hash map

Layout

A keyboard layout like ward stone ireland for parsing and similar tasks. Lists the keys in a layout for encoding outlines as bitsets.

Stroke

Represents a group of keys that are pressed simultaneously. Sometimes also used as a mask.

StrokeParseError

Error when parsing a stroke

Enums

JsonDictionaryError

Errors for Dictionary::add_json_bytes and Dictionary::add_json_file

Traits

Dict

A dictionary that can be queried for translations.

Type Aliases

Outline

A series of strokes