completers 0.0.5

A tiny Rust-native shell completion solution.
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

//! Possible errors.

use std::io;

/// Possible errors that can occur.
#[derive(Debug)]
pub enum CompletersError {
    /// Error while generating shell code.
    ShellCode(ShellCodeError),
    /// The completion request is missing a required field.
    MissingField,
    /// The completion request contains an invalid value for some field.
    InvalidValue {
        /// The field that contains the invalid value.
        field: String,
        /// The invalid value.
        value: String,
        /// The error message.
        what: String,
    },
    /// Unrecognized environment variable value.
    UnrecognizedEnvVar(String),
    /// Custom error message.
    Custom(String),
}

impl std::fmt::Display for CompletersError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::ShellCode(err) => {
                write!(f, "Shell code error: {err}")
            }
            Self::MissingField => write!(f, "Missing required field"),
            Self::InvalidValue { field, value, what } => {
                write!(f, "Invalid value for field {field}: {value} ({what})")
            }
            Self::UnrecognizedEnvVar(value) => {
                write!(f, "Unrecognized environment variable value: {value}")
            }
            Self::Custom(message) => write!(f, "Custom error: {message}"),
        }
    }
}

impl std::error::Error for CompletersError {}

impl From<ShellCodeError> for CompletersError {
    fn from(err: ShellCodeError) -> Self {
        Self::ShellCode(err)
    }
}

/// Possible errors that can occur when generating shell code.
#[derive(Debug)]
pub enum ShellCodeError {
    /// IO error.
    IO(io::Error),
    /// Encoding error.
    Encoding(String),
}

impl std::fmt::Display for ShellCodeError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::IO(err) => {
                write!(f, "IO error: {err}")
            }
            Self::Encoding(message) => {
                write!(f, "Encoding error: {message}")
            }
        }
    }
}

impl std::error::Error for ShellCodeError {}

impl From<io::Error> for ShellCodeError {
    fn from(err: io::Error) -> Self {
        Self::IO(err)
    }
}