apalis-board-types 1.0.0-rc.8

Shared types and data structures used by the apalis-board workspace.
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
107
108
109
110

#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
use serde::{Deserialize, Serialize};

/// Configuration module.
pub mod config;

/// The log level of a log entry.
#[derive(Default, Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "UPPERCASE")]
pub enum LogLevel {
    /// An informational level for general information.
    Info,
    /// A warning level for potential issues.
    Warn,
    /// An error level for serious issues.
    Error,
    /// Debug level for detailed debugging information.
    #[default]
    Debug,
    /// Trace level for detailed tracing information.
    Trace,
}

/// A log entry.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct LogEntry {
    /// An optional tracing span associated with the log entry.
    pub span: Option<Span>,
    /// The log level of the entry.
    pub level: LogLevel,
    /// The timestamp of the log entry.
    pub timestamp: String,
    /// The target of the log entry.
    pub target: String,
    /// The main content of the log entry.
    #[serde(rename = "fields")]
    pub entry: Entry,
}

/// A line entry.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LineEntry {
    /// The log target.
    #[serde(rename = "log.target")]
    pub log_target: String,
    /// The module path of the log.
    #[serde(rename = "log.module_path")]
    pub log_module_path: String,
    /// The file where the log was generated.
    #[serde(rename = "log.file")]
    pub log_file: String,
    /// The line number in the file where the log was generated.
    #[serde(rename = "log.line")]
    pub log_line: i64,
}

/// Additional information about a log entry.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum EntryType {
    /// A result entry.
    Result(ResultEntry),
    /// A line entry.
    Line(LineEntry),
}

/// A result entry.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]

pub struct ResultEntry {
    /// The time taken to complete the task.
    pub done_in: String,
    /// The result of the task.
    pub result: String,
}

/// A log entry.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]

pub struct Entry {
    /// The log message.
    pub message: Option<String>,
    /// Additional entry type information.
    #[serde(flatten)]
    pub entry_type: Option<EntryType>,
}

/// Information about a tracing span.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Span {
    /// The unique identifier for the span.
    pub attempt: i64,
    /// The task ID associated with the span.
    pub task_id: String,
    /// The name of the span.
    pub name: String,
}

/// An enumeration of possible API errors.
#[derive(Debug, thiserror::Error, Serialize, Deserialize)]
#[serde(tag = "type", content = "message")]
pub enum ApiError {
    /// Error related to codec operations.
    #[error("Codec error: {0}")]
    CodecError(String),
    /// Error related to backend operations.
    #[error("Backend error: {0}")]
    BackendError(String),
}