rdocs 0.1.2

Code Documentation Made Simple
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

//! A module for handling command line exits with custom messages and exit
//! codes.
//!
//! This module provides a convenient way to handle command line exits with
//! custom messages and exit codes.
use std::process::exit;

/// Represents a command exit object with a custom message and exit code.
#[derive(Debug)]
pub struct CmdExit {
    /// The exit code associated with the exit.
    pub code: i32,
    /// The optional message associated with the exit.
    pub message: Option<String>,
}

impl CmdExit {
    /// Creates a new [`CmdExit`] instance with an error message and exit code
    /// 1.
    #[must_use]
    pub fn error_with_message(message: &str) -> Self {
        Self {
            code: 1,
            message: Some(format!("❗ {message}")),
        }
    }

    /// Creates a new [`CmdExit`] instance with a success message and exit code
    /// 0.
    #[must_use]
    pub fn ok_with_message(message: &str) -> Self {
        Self {
            code: 0,
            message: Some(message.to_string()),
        }
    }

    /// Creates a new [`CmdExit`] instance with a success message and exit code
    /// 0 without any message.
    #[must_use]
    pub const fn ok() -> Self {
        Self {
            code: 0,
            message: None,
        }
    }

    /// Exits the command line with the configured message and exit code.
    pub fn exit(&self) {
        if let Some(message) = &self.message {
            eprintln!("{message}");
        };

        exit(self.code);
    }
}