ispell 0.1.0

Easily run ispell or aspell from Rust
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

rust-ispell 
===========

This library allows to easily use `ispell` or `aspell` from Rust.

Usage
-----

Add this to your `Cargo.toml`

```toml
[dependencies]
ispell = "0.1"
```

Example
-------

```rust
extern crate ispell;
use ispell::SpellLauncher;

fn main() {
    let mut checker = SpellLauncher::new()
        .aspell(true)
        .language("en_GB")
        .launch()
        .unwrap();
    let errors = checker.check("A simpel test to see if it detetcs typing errors").unwrap();
    for e in errors {
        println!("'{}' (pos: {}) is mispelled!", &e.mispelled, e.position);
        if !e.suggestions.is_empty() {
            println!("Maybe you meant '{}'?", &e.suggestions[0]);
        }
    }
}
```

will display:

```
'simpel' (pos: 2) is mispelled!
Maybe you meant 'simple'?
'detetcs' (pos: 27) is mispelled!
Maybe you meant 'dietetics'?
```

(*Yes*, that is exactly what I meant.)

For more information about using this library, see the [API documentation](https://lise-henry.github.io/rust-ispell/ispell/).

License 
-------

`rust-ispell` is published under the [Mozilla Public License, version 2.0](https://www.mozilla.org/en-US/MPL/2.0/).