twyg 0.6.3

A tiny logging setup for Rust applications
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

//! Error types for the twyg logging library.
//!
//! This module provides custom error types for twyg operations using the
//! [`thiserror`](https://docs.rs/thiserror) crate for ergonomic error handling.
//!
//! # Error Types
//!
//! - [`TwygError`] - The main error type for all twyg operations
//! - [`Result<T>`] - Type alias for `std::result::Result<T, TwygError>`
//!
//! # Examples
//!
//! ```
//! use twyg::{OptsBuilder, LogLevel};
//!
//! // Invalid time format returns ConfigError
//! let result = OptsBuilder::new()
//!     .time_format("%invalid")
//!     .build();
//! assert!(result.is_err());
//! ```

use std::io;

use thiserror::Error;

/// Custom error type for twyg operations.
#[derive(Debug, Error)]
pub enum TwygError {
    /// Invalid time format string provided.
    #[error("invalid time format '{format}': {source}")]
    InvalidTimeFormat {
        format: String,
        #[source]
        source: io::Error,
    },

    /// Failed to initialize the logger.
    #[error("failed to initialize logger")]
    InitError,

    /// Failed to open or write to log file.
    #[error("failed to open log file: {0}")]
    FileError(#[from] io::Error),

    /// Configuration error.
    #[error("configuration error: {0}")]
    ConfigError(String),
}

/// Result type alias using TwygError.
pub type Result<T> = std::result::Result<T, TwygError>;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_error_display() {
        let err = TwygError::ConfigError("test error".to_string());
        assert_eq!(err.to_string(), "configuration error: test error");
    }

    #[test]
    fn test_file_error() {
        let io_err = io::Error::new(io::ErrorKind::NotFound, "file not found");
        let err = TwygError::FileError(io_err);
        assert!(err.to_string().contains("failed to open log file"));
    }

    #[test]
    fn test_invalid_time_format() {
        let io_err = io::Error::new(io::ErrorKind::InvalidInput, "bad format");
        let err = TwygError::InvalidTimeFormat {
            format: "%Z".to_string(),
            source: io_err,
        };
        assert!(err.to_string().contains("invalid time format"));
        assert!(err.to_string().contains("%Z"));
    }
}