ispell 0.3.1

Easily run ispell, hunspell 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
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
98
99
100
101
102
103
104

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with
// this file, You can obtain one at https://mozilla.org/MPL/2.0/.

use std::error;
use std::result;
use std::fmt;
use std::string::FromUtf8Error;
use std::io;

/// Internal ErrorType
#[derive(Debug, PartialEq)]
enum ErrorType {
    /// Default
    Default,
    Process,
    Utf8,
    Protocol,
    InvalidWord,
}

/// Result type (returned by most methods of this library)
pub type Result<T> = result::Result<T, Error>;

#[derive(Debug, PartialEq)]
/// Error type returned by methods of this library
pub struct Error {
    msg: String,
    variant: ErrorType
}

impl Error {
    /// Creates a new default error
    pub fn new<S: Into<String>>(msg: S) -> Error {
        Error {
            msg: msg.into(),
            variant: ErrorType::Default,
        }
    }

    /// Create a new process error
    ///
    /// (for errors launching Ispell)
    pub fn process<S: Into<String>>(msg: S) -> Error {
        Error {
            msg: msg.into(),
            variant: ErrorType::Process
        }
    }

    /// Create a new UTF8 error
    ///
    /// (for errors converting to UTF8)
    pub fn utf8<S: Into<String>>(msg: S) -> Error {
        Error {
            msg: msg.into(),
            variant: ErrorType::Utf8,
        }
    }

    /// Creates a new protocol error
    ///
    /// (when we didn't understand ispell output)
    pub fn protocol<S: Into<String>>(msg: S) -> Error {
        Error {
            msg: msg.into(),
            variant: ErrorType::Protocol,
        }
    }

    /// Creates a new invalid word error
    ///
    /// (when the user uses illegal characters in a word)
    pub fn invalid_word<S: Into<String>>(msg: S) -> Error {
        Error {
            msg: msg.into(),
            variant: ErrorType::InvalidWord,
        }
    }
}

impl error::Error for Error {
    fn description(&self) -> &str {
        &self.msg
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.msg)
    }
}

impl From<FromUtf8Error> for Error {
    fn from(err: FromUtf8Error) -> Error {
        Error::utf8(format!("error decoding ispell output to utf8: {}", err))
    }
}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Error {
        Error::process(format!("error while reading/writing to ispell: {}", err))
    }
}