leo_errors/common/
traits.rs

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
// Copyright (C) 2019-2025 Provable Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

/// MessageCode trait that all Errors should implement.
pub trait LeoMessageCode: Sized {
    /// Returns the error's exit code for the program.
    fn exit_code(&self) -> i32;

    /// Returns the prefixed error identifier.
    fn error_code(&self) -> String;

    /// Returns the prefixed warning identifier.
    fn warning_code(&self) -> String;

    /// Returns the messages's exit code mask, as to avoid conflicts.
    fn code_mask() -> i32;

    /// Returns the message's code type for the program.
    fn message_type() -> String;

    /// Returns if the message is an error or warning.
    fn is_error() -> bool;

    /// The LeoErrorCode which has a default code identifier of 037
    /// (Leo upsidedown and backwards). This is to make the exit codes
    /// unique to Leo itself.
    #[inline(always)]
    fn code_identifier() -> i8 {
        37
    }
}