daedalus-core 1.0.0

Core types and shared utilities for the Daedalus dataflow stack.
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

use serde::{Deserialize, Serialize};
use thiserror::Error;

/// Stable error codes for `daedalus-core`.
///
/// ```
/// use daedalus_core::errors::CoreErrorCode;
/// let code = CoreErrorCode::InvalidId;
/// assert_eq!(format!("{code:?}"), "InvalidId");
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "snake_case")]
pub enum CoreErrorCode {
    InvalidId,
    InvalidTick,
    InvalidSequence,
    ChannelClosed,
    ChannelFull,
    ChannelEmpty,
    Unsupported,
    Internal,
}

/// Structured core error with a stable code and human-friendly message.
///
/// ```
/// use daedalus_core::errors::{CoreError, CoreErrorCode};
/// let err = CoreError::new(CoreErrorCode::InvalidId, "bad id");
/// assert_eq!(err.code(), CoreErrorCode::InvalidId);
/// assert_eq!(err.message(), "bad id");
/// ```
#[derive(Debug, Clone, Error, Serialize, Deserialize)]
#[non_exhaustive]
#[error("{code:?}: {message}")]
pub struct CoreError {
    code: CoreErrorCode,
    message: String,
}

impl CoreError {
    pub fn new(code: CoreErrorCode, message: impl Into<String>) -> Self {
        Self {
            code,
            message: message.into(),
        }
    }

    pub fn code(&self) -> CoreErrorCode {
        self.code
    }

    pub fn message(&self) -> &str {
        &self.message
    }

    /// Attach additional context while keeping the same code.
    pub fn with_context(self, context: impl Into<String>) -> Self {
        let combined = format!("{}: {}", context.into(), self.message);
        Self {
            code: self.code,
            message: combined,
        }
    }
}

/// Convenience alias for core results.
pub type CoreResult<T> = Result<T, CoreError>;

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

    #[test]
    fn serde_round_trip() {
        let err = CoreError::new(CoreErrorCode::InvalidId, "bad id");
        let json = serde_json::to_string(&err).expect("serialize");
        let back: CoreError = serde_json::from_str(&json).expect("deserialize");
        assert_eq!(back.code(), CoreErrorCode::InvalidId);
        assert_eq!(back.message(), "bad id");
    }

    #[test]
    fn display_includes_code() {
        let err = CoreError::new(CoreErrorCode::ChannelFull, "full");
        let rendered = err.to_string();
        assert!(rendered.contains("ChannelFull"));
        assert!(rendered.contains("full"));
    }
}