zspell 0.3.3

Native Rust library for spellchecking, with a command line interface
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Various functions that are helpful throughout the crate

use core::fmt::Display;
use std::borrow::Borrow;
use std::hash::Hash;
use std::ops::Deref;
use std::rc::Rc;
use std::sync::Arc;

use hashbrown::Equivalent;
use regex::Regex;

use crate::affix::RuleType;

/// Wrap `Regex` objects so they can be hashed
#[derive(Clone, Debug)]
pub struct ReWrapper(Regex);

impl ReWrapper {
    pub fn new(re: &str) -> Result<Self, regex::Error> {
        Ok(Self(Regex::new(re)?))
    }
}

impl Eq for ReWrapper {}

impl PartialEq for ReWrapper {
    fn eq(&self, other: &Self) -> bool {
        self.0.as_str() == other.0.as_str()
    }
}

impl Hash for ReWrapper {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.0.as_str().hash(state);
    }
}

impl Deref for ReWrapper {
    type Target = Regex;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

/// Convert any integer to a u32, panic if it does not fit
#[inline]
pub fn convertu32<T: TryInto<u32> + Display + Copy>(value: T) -> u32 {
    value
        .try_into()
        .unwrap_or_else(|_| panic!("value {value} overflows u32 max of {}", u32::MAX))
}

/// Compile a regex pattern in the context of an affix. Returns None if
/// the universal pattern "." is provided
pub fn compile_re_pattern(
    condition: &str,
    kind: RuleType,
) -> Result<Option<ReWrapper>, regex::Error> {
    if condition == "." {
        return Ok(None);
    }
    let re_pattern = match kind {
        RuleType::Prefix => format!("^{condition}.*$"),
        RuleType::Suffix => format!("^.*{condition}$"),
    };
    ReWrapper::new(re_pattern.as_str()).map(Some)
}

/// Implement a type that derefs to compare to a string
#[derive(Clone, Debug, PartialEq, Hash, Eq)]
pub struct StrWrapper<'a>(pub &'a str);

impl<'a> StrWrapper<'a> {
    pub fn new(s: &'a str) -> Self {
        Self(s)
    }
}

impl Display for StrWrapper<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl Equivalent<Rc<String>> for StrWrapper<'_> {
    fn equivalent(&self, key: &Rc<String>) -> bool {
        self.0 == key.as_ref()
    }
}

impl Equivalent<Arc<String>> for StrWrapper<'_> {
    fn equivalent(&self, key: &Arc<String>) -> bool {
        self.0 == key.as_ref()
    }
}