tasg 0.1.0

Manage your tasks with `tasg`!
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! Error Handling for Task Operations
//!
//! This module defines the custom error type `TaskError` used for handling errors
//! in task-related operations within the task management CLI application.

use std::fmt;

/// Custom error type for task-related operations.
///
/// The `TaskError` enum encapsulates various errors that can occur while managing tasks,
/// including task not found errors, I/O errors, serialization/deserialization errors, and invalid input.
#[derive(Debug)]
pub enum TaskError {
    /// Error indicating that a task with the specified ID was not found.
    ///
    /// # Fields
    ///
    /// * `u32` - The ID of the task that was not found.
    NotFound(u32),

    /// Error representing an I/O operation failure.
    ///
    /// This variant wraps a standard `std::io::Error`.
    ///
    /// # Fields
    ///
    /// * `std::io::Error` - The I/O error that occurred.
    IoError(std::io::Error),

    /// Error representing a serialization/deserialization failure.
    ///
    /// This variant wraps a `serde_json::Error` from the `serde_json` crate.
    ///
    /// # Fields
    ///
    /// * `serde_json::Error` - The serialization or deserialization error that occurred.
    SerdeError(serde_json::Error),

    /// Error representing invalid input.
    ///
    /// # Fields
    ///
    /// * `String` - Message stating why input is invalid.
    InvalidInput(String),
}

impl fmt::Display for TaskError {
    /// Formats the `TaskError` for display purposes.
    ///
    /// This implementation provides a user-friendly description of the error, which is useful
    /// for displaying error messages to the end-user.
    ///
    /// # Arguments
    ///
    /// * `f` - The formatter used to write the formatted string.
    ///
    /// # Returns
    ///
    /// * `fmt::Result` - The result of the formatting operation.
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            TaskError::NotFound(id) => write!(f, "Task with ID {} not found", id),
            TaskError::IoError(e) => write!(f, "I/O error - {}", e),
            TaskError::SerdeError(e) => write!(f, "Serialization error -  {}", e),
            TaskError::InvalidInput(msg) => write!(f, "Invalid input - {}", msg),
        }
    }
}

impl std::error::Error for TaskError {}

impl From<std::io::Error> for TaskError {
    /// Converts a `std::io::Error` into a `TaskError`.
    ///
    /// This implementation allows I/O errors to be seamlessly converted into `TaskError::IoError` variants,
    /// enabling better error handling in task-related operations.
    ///
    /// # Arguments
    ///
    /// * `error` - The `std::io::Error` to convert.
    ///
    /// # Returns
    ///
    /// * `TaskError` - The corresponding `TaskError` variant.
    fn from(error: std::io::Error) -> Self {
        TaskError::IoError(error)
    }
}

impl From<serde_json::Error> for TaskError {
    /// Converts a `serde_json::Error` into a `TaskError`.
    ///
    /// This implementation allows serialization and deserialization errors to be seamlessly converted
    /// into `TaskError::SerdeError` variants, enabling better error handling in task-related operations.
    ///
    /// # Arguments
    ///
    /// * `error` - The `serde_json::Error` to convert.
    ///
    /// # Returns
    ///
    /// * `TaskError` - The corresponding `TaskError` variant.
    fn from(error: serde_json::Error) -> Self {
        TaskError::SerdeError(error)
    }
}