eck 0.0.3

A fast, simple file & folder encryption manager, written in Rust
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

use crate::diagnostic::output::snippet::Snippet;
use crate::{diagnostic::output::kind::EnkryptitOutputKind, errors::EnkryptitError};

pub mod diagnostic;
pub mod display;
pub mod kind;
pub mod snippet;

/// An Output, defined by its [`EnkryptitOutputKind`] and the message it contains.
/// \
/// Once created (and maybe passed trough some functions), it is displayed calling [`EnkryptitOutput::display()`]
pub struct EnkryptitOutput {
    kind: EnkryptitOutputKind,
    msg: String,
}

impl EnkryptitOutput {
    /// Creates an [`EnkryptitOutput`] of the given [`EnkryptitOutputKind`] and with the given message.
    pub fn new(kind: EnkryptitOutputKind, msg: impl Into<String>) -> Self {
        Self {
            kind,
            msg: msg.into(),
        }
    }

    /// Creates an empty [`EnkryptitOutput`] that will not be displayed.
    pub fn phantom() -> Self {
        Self {
            kind: EnkryptitOutputKind::Phantom,
            msg: String::new(),
        }
    }

    /// Creates an [`EnkryptitOutput`] with the given message and of kind [`EnkryptitOutputKind::Success`]
    pub fn success(msg: impl Into<String>) -> Self {
        Self {
            kind: EnkryptitOutputKind::Success,
            msg: msg.into(),
        }
    }

    /// Creates an [`EnkryptitOutput`] with the given message and of kind [`EnkryptitOutputKind::Info`]
    ///
    /// Currently unused by the binary (see the commented-out call sites in the
    /// TUI); kept as public API for future informational output.
    #[allow(dead_code)]
    pub fn info(msg: impl Into<String>) -> Self {
        Self {
            kind: EnkryptitOutputKind::Info,
            msg: msg.into(),
        }
    }

    /// Creates an [`EnkryptitOutput`] with the given message and of kind [`EnkryptitOutputKind::Warning`]
    pub fn warning(msg: impl Into<String>) -> Self {
        Self {
            kind: EnkryptitOutputKind::Warning,
            msg: msg.into(),
        }
    }

    /// Creates an [`EnkryptitOutput`] with the given message, error and of kind [`EnkryptitOutputKind::Error`]
    pub fn error(msg: impl Into<String>, error: EnkryptitError) -> Self {
        Self {
            kind: EnkryptitOutputKind::Error {
                error,
                location: None,
                help: None,
                snippet: None,
            },
            msg: msg.into(),
        }
    }

    /// Attach a location hint (e.g. the operation/step that failed) to an [`EnkryptitOutput`] of kind [`EnkryptitOutputKind::Error`].
    pub fn with_location(mut self, location: impl Into<String>) -> Self {
        if let EnkryptitOutputKind::Error { location: slot, .. } = &mut self.kind {
            *slot = Some(location.into());
        }
        self
    }

    /// Attach a remediation hint for the user to an [`EnkryptitOutput`] of kind [`EnkryptitOutputKind::Error`].
    pub fn with_help(mut self, help: impl Into<String>) -> Self {
        if let EnkryptitOutputKind::Error { help: slot, .. } = &mut self.kind {
            *slot = Some(help.into());
        }
        self
    }

    /// Attach a source snippet used to draw a miette code frame pointing at
    /// the offending token. Only meaningful for error outputs.
    pub fn with_snippet(mut self, snippet: Snippet) -> Self {
        if let EnkryptitOutputKind::Error { snippet: slot, .. } = &mut self.kind {
            *slot = Some(snippet);
        }
        self
    }
}