lilo-rm-core 0.7.1

Runtime Matters core protocol types and JSON line wire contract for rtmd clients
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

use std::path::PathBuf;

use serde::{Deserialize, Serialize};
use uuid::Uuid;

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(tag = "type", content = "payload", rename_all = "snake_case")]
pub enum LogAvailability {
    Headless {
        stdout_path: PathBuf,
        stderr_path: PathBuf,
    },
    TmuxPaneSnapshot,
    Unavailable {
        reason: LogsUnavailableReason,
    },
}

#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum LogsUnavailableReason {
    TmuxTarget,
    CaptureDisabled,
    PaneUnavailable,
    PipeInUse,
    RecorderFailed,
}

impl LogsUnavailableReason {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::TmuxTarget => "tmux_target",
            Self::CaptureDisabled => "capture_disabled",
            Self::PaneUnavailable => "pane_unavailable",
            Self::PipeInUse => "pipe_in_use",
            Self::RecorderFailed => "recorder_failed",
        }
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct CaptureRequest {
    pub session_id: Uuid,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub scrollback_lines: Option<u32>,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct PaneSnapshot {
    pub content: String,
    pub captured_at_ms: u64,
    pub scrollback_lines_requested: u32,
    pub scrollback_lines_included: u32,
    pub pane_history_lines: u32,
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[non_exhaustive]
#[serde(tag = "type", content = "payload", rename_all = "snake_case")]
pub enum CaptureError {
    NotATmuxTarget,
    PaneUnavailable,
    SessionMissing,
    TmuxNotAvailable,
    CapturePaneFailed { stderr: String },
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[non_exhaustive]
#[serde(tag = "status", content = "payload", rename_all = "snake_case")]
pub enum CaptureResponse {
    Captured(PaneSnapshot),
    Failed(CaptureError),
}

impl CaptureResponse {
    pub fn into_result(self) -> Result<PaneSnapshot, CaptureError> {
        match self {
            Self::Captured(snapshot) => Ok(snapshot),
            Self::Failed(error) => Err(error),
        }
    }
}

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

    #[test]
    fn logs_unavailable_reason_as_str_matches_serde_snake_case() {
        assert_eq!(LogsUnavailableReason::TmuxTarget.as_str(), "tmux_target");
        assert_eq!(
            LogsUnavailableReason::CaptureDisabled.as_str(),
            "capture_disabled"
        );
        assert_eq!(
            LogsUnavailableReason::PaneUnavailable.as_str(),
            "pane_unavailable"
        );
        assert_eq!(LogsUnavailableReason::PipeInUse.as_str(), "pipe_in_use");
        assert_eq!(
            LogsUnavailableReason::RecorderFailed.as_str(),
            "recorder_failed"
        );
    }
}