hyprcorrect-core 0.2.5

Core logic for hyprcorrect: configuration, the keystroke buffer, and correction providers.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Core logic for hyprcorrect: configuration, the keystroke buffer,
//! replacement planning, and the correction-provider interface.
//!
//! This crate has no GUI or platform dependencies. See `DESIGN.md` at
//! the repository root for the architecture.

pub mod buffer;
pub mod chord;
pub mod config;
pub mod definitions;
pub mod languagetool;
pub mod llm;
pub mod providers;
pub mod replace;
pub mod runtime;
pub mod secrets;

pub use buffer::{Buffer, Key, NearbyWord, Sentence, SentenceAtCaret, WordAtCaret};
pub use chord::{Chord, ChordError};
pub use config::{
    Behavior, Config, ConfigError, DefinitionSource, Hotkeys, LanguageToolConfig, LlmConfig,
    Privacy, ProviderId, Providers, ResetKeys,
};
pub use definitions::{define, define_online};
pub use languagetool::{LanguageToolError, LanguageToolProvider};
pub use llm::{LlmError, LlmProvider};
pub use providers::{Context, Correction, CorrectionProvider, OfflineProvider};
pub use replace::{Edit, plan_word_replacement};

/// hyprcorrect's version string, surfaced by the CLI and the About pane.
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}