i3nator 1.2.0

i3nator is Tmuxinator for the i3 window manager
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

// Copyright Pit Kleyersburg <pitkley@googlemail.com>
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified or distributed
// except according to those terms.

//! Errors, using [`error-chain`][error-chain].
//!
//! [error-chain]: https://crates.io/crates/error-chain

use error_chain::error_chain;

error_chain! {
    foreign_links {
        I3EstablishError(::i3ipc::EstablishError)
            #[doc = "Error caused by `i3ipc`, on establishing a connection."];

        I3MessageError(::i3ipc::MessageError)
            #[doc = "Error caused by `i3ipc`, on sending a message."];

        IoError(::std::io::Error)
            #[doc = "Error mapping to `std::io::Error`."];

        Utf8Error(::std::str::Utf8Error)
            #[doc = "Error mapping to `std::str::Utf8Error`."];

        TomlError(::toml::de::Error)
            #[doc = "Error caused by `toml`, on deserializing using Serde."];
    }

    errors {
        /// An error that occurs if a trait-function is called that cannot be implemented.
        ///
        /// (This is pretty unclean but is currently required as `ConfigFileImpl` cannot implement
        /// any of the static functions of the `ConfigFile` trait since it is missing the required
        /// prefix.)
        CantBeImplemented(t: String) {
            description("called function cannot be implemented")
            display("called function cannot be implemented: '{}'", t)
        }

        /// An error that can occur when splitting a string into a
        /// [`ApplicationCommand`][struct-ApplicationCommand].
        ///
        /// [struct-ApplicationCommand]: ../types/struct.ApplicationCommand.html
        CommandSplittingFailed(t: String) {
            description("command splitting failed")
            display("command splitting failed: '{}'", t)
        }

        /// An error that occurs if a project under the same name already exists.
        ConfigExists(p: String, t: String) {
            description("config already exists")
            display("config of type '{}' already exists: '{}'", p, t)
        }

        /// An error that occurs when the default editor is not specified.
        ///
        /// One of the environment variables `$VISUAL` or `$EDITOR` has to be set.
        EditorNotFound {
            description("cannot find an editor")
            display("cannot find an editor. Please specify $VISUAL or $EDITOR")
        }

        /// An error that occurs when a `Path` (i.e. `OsStr`) cannot be converted to UTF8.
        InvalidUtF8Path(t: String) {
            description("path is invalid UTF8")
            display("path is invalid UTF8: '{}'", t)
        }

        /// An error that occurs if a specified path does not exist.
        PathDoesntExist(t: String) {
            description("path doesn't exist")
            display("path doesn't exist: '{}'", t)
        }

        /// An error that occurs if text or key-presses could not be input into an application.
        TextOrKeyInputFailed {
            description("text or key input failed")
            display("inputting text or key-presses into an application failed")
        }

        /// An error that occurs if a project does not exist under a specified name.
        UnknownConfig(p: String, t: String) {
            description("config is unknown")
            display("config of type '{}' is unknown: '{}'", p, t)
        }
    }
}