rmux-client 0.1.0

Blocking local client and attach-mode plumbing for the RMUX terminal multiplexer.
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

use rmux_proto::{AttachShellCommand, RmuxError};

use crate::ClientError;

use super::terminal::RawTerminal;

pub(super) trait AttachActionExecutor {
    fn handle_lock(&mut self, command: &AttachShellCommand)
        -> std::result::Result<(), ClientError>;
    fn handle_legacy_lock(&mut self, command: &str) -> std::result::Result<(), ClientError>;
    fn handle_suspend(&mut self) -> std::result::Result<(), ClientError>;
    fn handle_detach_kill(&mut self) -> std::result::Result<(), ClientError>;
    fn handle_detach_exec(
        &mut self,
        command: &AttachShellCommand,
    ) -> std::result::Result<(), ClientError>;
    fn handle_legacy_detach_exec(&mut self, command: &str) -> std::result::Result<(), ClientError>;
}

#[derive(Debug)]
pub(super) enum AttachAction {
    Lock(AttachShellCommand),
    LegacyLock(String),
    Suspend,
    DetachKill,
    DetachExec(AttachShellCommand),
    LegacyDetachExec(String),
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(super) enum AttachActionOutcome {
    Unlock,
    Exit,
}

#[derive(Debug)]
pub(super) struct ManagedTerminalActions {
    terminal: RawTerminal,
}

impl ManagedTerminalActions {
    pub(super) fn new(terminal: RawTerminal) -> Self {
        Self { terminal }
    }
}

impl AttachActionExecutor for ManagedTerminalActions {
    fn handle_lock(
        &mut self,
        command: &AttachShellCommand,
    ) -> std::result::Result<(), ClientError> {
        self.terminal
            .run_lock_command(command)
            .map_err(ClientError::from)
    }

    fn handle_legacy_lock(&mut self, command: &str) -> std::result::Result<(), ClientError> {
        self.terminal
            .run_legacy_lock_command(command)
            .map_err(ClientError::from)
    }

    fn handle_suspend(&mut self) -> std::result::Result<(), ClientError> {
        self.terminal.suspend_self().map_err(ClientError::from)
    }

    fn handle_detach_kill(&mut self) -> std::result::Result<(), ClientError> {
        self.terminal.restore().map_err(ClientError::from)
    }

    fn handle_detach_exec(
        &mut self,
        command: &AttachShellCommand,
    ) -> std::result::Result<(), ClientError> {
        self.terminal
            .run_detach_exec_command(command)
            .map_err(ClientError::from)
    }

    fn handle_legacy_detach_exec(&mut self, command: &str) -> std::result::Result<(), ClientError> {
        self.terminal
            .run_legacy_detach_exec_command(command)
            .map_err(ClientError::from)
    }
}

#[derive(Debug, Default)]
pub(super) struct StreamOnlyActions;

impl AttachActionExecutor for StreamOnlyActions {
    fn handle_lock(
        &mut self,
        _command: &AttachShellCommand,
    ) -> std::result::Result<(), ClientError> {
        Err(unmanaged_terminal_error("lock"))
    }

    fn handle_legacy_lock(&mut self, _command: &str) -> std::result::Result<(), ClientError> {
        Err(unmanaged_terminal_error("lock"))
    }

    fn handle_suspend(&mut self) -> std::result::Result<(), ClientError> {
        Err(unmanaged_terminal_error("suspend"))
    }

    fn handle_detach_kill(&mut self) -> std::result::Result<(), ClientError> {
        Ok(())
    }

    fn handle_detach_exec(
        &mut self,
        _command: &AttachShellCommand,
    ) -> std::result::Result<(), ClientError> {
        Err(unmanaged_terminal_error("detach exec"))
    }

    fn handle_legacy_detach_exec(
        &mut self,
        _command: &str,
    ) -> std::result::Result<(), ClientError> {
        Err(unmanaged_terminal_error("detach exec"))
    }
}

fn unmanaged_terminal_error(action: &str) -> ClientError {
    ClientError::Protocol(RmuxError::Decode(format!(
        "received unexpected {action} request without a managed terminal"
    )))
}

pub(super) fn run_attach_action(
    actions: &mut impl AttachActionExecutor,
    action: AttachAction,
) -> std::result::Result<AttachActionOutcome, ClientError> {
    match action {
        AttachAction::Lock(command) => {
            actions.handle_lock(&command)?;
            Ok(AttachActionOutcome::Unlock)
        }
        AttachAction::LegacyLock(command) => {
            actions.handle_legacy_lock(&command)?;
            Ok(AttachActionOutcome::Unlock)
        }
        AttachAction::Suspend => {
            actions.handle_suspend()?;
            Ok(AttachActionOutcome::Unlock)
        }
        AttachAction::DetachKill => {
            actions.handle_detach_kill()?;
            Ok(AttachActionOutcome::Exit)
        }
        AttachAction::DetachExec(command) => {
            actions.handle_detach_exec(&command)?;
            Ok(AttachActionOutcome::Exit)
        }
        AttachAction::LegacyDetachExec(command) => {
            actions.handle_legacy_detach_exec(&command)?;
            Ok(AttachActionOutcome::Exit)
        }
    }
}