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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
use serde::{Deserialize, Serialize};
use crate::{ClientTerminalContext, SessionName, TerminalSize};
/// Request payload for `attach-session`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AttachSessionRequest {
/// The exact target session name.
pub target: SessionName,
}
/// Extended request payload for `attach-session`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AttachSessionExtRequest {
/// The optional exact target session name.
pub target: Option<SessionName>,
/// Whether other attached clients should be detached first.
#[serde(default)]
pub detach_other_clients: bool,
/// Whether other attached clients should be detached and terminated.
#[serde(default)]
pub kill_other_clients: bool,
/// Whether readonly attach mode should be enabled.
#[serde(default)]
pub read_only: bool,
/// Whether client environment updates should be skipped.
#[serde(default)]
pub skip_environment_update: bool,
/// Optional tmux client-flag names such as `read-only` or `active-pane`.
#[serde(default)]
pub flags: Option<Vec<String>>,
}
/// Further-extended request payload for `attach-session`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AttachSessionExt2Request {
/// The optional exact target session name.
#[serde(default)]
pub target: Option<SessionName>,
/// The optional raw tmux-style target text, including window/pane selectors.
#[serde(default)]
pub target_spec: Option<String>,
/// Whether other attached clients should be detached first.
#[serde(default)]
pub detach_other_clients: bool,
/// Whether other attached clients should be detached and terminated.
#[serde(default)]
pub kill_other_clients: bool,
/// Whether readonly attach mode should be enabled.
#[serde(default)]
pub read_only: bool,
/// Whether client environment updates should be skipped.
#[serde(default)]
pub skip_environment_update: bool,
/// Optional tmux client-flag names such as `read-only` or `active-pane`.
#[serde(default)]
pub flags: Option<Vec<String>>,
/// Optional tmux format-expanded working directory applied to the target session.
#[serde(default)]
pub working_directory: Option<String>,
/// Terminal/runtime hints captured from the invoking client.
#[serde(default)]
pub client_terminal: ClientTerminalContext,
/// The invoking client terminal size, when known.
#[serde(default)]
pub client_size: Option<TerminalSize>,
}
/// Attach request payload with explicit attach-stream client capabilities.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct AttachSessionExt3Request {
/// The optional exact target session name.
#[serde(default)]
pub target: Option<SessionName>,
/// The optional raw tmux-style target text, including window/pane selectors.
#[serde(default)]
pub target_spec: Option<String>,
/// Whether other attached clients should be detached first.
#[serde(default)]
pub detach_other_clients: bool,
/// Whether other attached clients should be detached and terminated.
#[serde(default)]
pub kill_other_clients: bool,
/// Whether readonly attach mode should be enabled.
#[serde(default)]
pub read_only: bool,
/// Whether client environment updates should be skipped.
#[serde(default)]
pub skip_environment_update: bool,
/// Optional tmux client-flag names such as `read-only` or `active-pane`.
#[serde(default)]
pub flags: Option<Vec<String>>,
/// Optional tmux format-expanded working directory applied to the target session.
#[serde(default)]
pub working_directory: Option<String>,
/// Terminal/runtime hints captured from the invoking client.
#[serde(default)]
pub client_terminal: ClientTerminalContext,
/// The invoking client terminal size, when known.
#[serde(default)]
pub client_size: Option<TerminalSize>,
/// Attach-stream messages this client can decode.
#[serde(default)]
pub attach_capabilities: Vec<String>,
}
impl AttachSessionExt3Request {
/// Builds the capability-aware request from the v2 attach request shape.
#[must_use]
pub fn from_ext2(request: AttachSessionExt2Request, attach_capabilities: Vec<String>) -> Self {
Self {
target: request.target,
target_spec: request.target_spec,
detach_other_clients: request.detach_other_clients,
kill_other_clients: request.kill_other_clients,
read_only: request.read_only,
skip_environment_update: request.skip_environment_update,
flags: request.flags,
working_directory: request.working_directory,
client_terminal: request.client_terminal,
client_size: request.client_size,
attach_capabilities,
}
}
/// Splits out the v2 payload fields and the attach-stream capabilities.
#[must_use]
pub fn into_ext2_and_capabilities(self) -> (AttachSessionExt2Request, Vec<String>) {
(
AttachSessionExt2Request {
target: self.target,
target_spec: self.target_spec,
detach_other_clients: self.detach_other_clients,
kill_other_clients: self.kill_other_clients,
read_only: self.read_only,
skip_environment_update: self.skip_environment_update,
flags: self.flags,
working_directory: self.working_directory,
client_terminal: self.client_terminal,
client_size: self.client_size,
},
self.attach_capabilities,
)
}
}
/// Request payload for `switch-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SwitchClientRequest {
/// The exact target session name.
pub target: SessionName,
}
/// Extended request payload for `switch-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SwitchClientExtRequest {
/// The optional exact target session name.
pub target: Option<SessionName>,
/// The optional key table to set for the attached client.
pub key_table: Option<String>,
}
/// Further-extended request payload for `switch-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SwitchClientExt2Request {
/// The optional exact target session name.
pub target: Option<SessionName>,
/// The optional key table to set for the attached client.
#[serde(default)]
pub key_table: Option<String>,
/// Whether the client's last session should be recalled.
#[serde(default)]
pub last_session: bool,
/// Whether the next session in order should be selected.
#[serde(default)]
pub next_session: bool,
/// Whether the previous session in order should be selected.
#[serde(default)]
pub previous_session: bool,
/// Whether readonly mode should be toggled for the addressed client.
#[serde(default)]
pub toggle_read_only: bool,
/// Reserved legacy field kept for wire compatibility; `switch-client` does not support `-f`.
#[serde(default)]
pub flags: Option<Vec<String>>,
/// Optional tmux list-sorting token used by `-n` and `-p`.
#[serde(default)]
pub sort_order: Option<String>,
/// Whether client environment updates should be skipped.
#[serde(default)]
pub skip_environment_update: bool,
}
/// Further-extended request payload for `switch-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SwitchClientExt3Request {
/// The optional target-client identifier or `=`.
#[serde(default)]
pub target_client: Option<String>,
/// The optional tmux target string, including pane or window targets.
#[serde(default)]
pub target: Option<String>,
/// The optional key table to set for the attached client.
#[serde(default)]
pub key_table: Option<String>,
/// Whether the client's last session should be recalled.
#[serde(default)]
pub last_session: bool,
/// Whether the next session in order should be selected.
#[serde(default)]
pub next_session: bool,
/// Whether the previous session in order should be selected.
#[serde(default)]
pub previous_session: bool,
/// Whether readonly mode should be toggled for the addressed client.
#[serde(default)]
pub toggle_read_only: bool,
/// Optional tmux list-sorting token used by `-n` and `-p`.
#[serde(default)]
pub sort_order: Option<String>,
/// Whether client environment updates should be skipped.
#[serde(default)]
pub skip_environment_update: bool,
/// Whether zoom should be preserved when switching panes.
#[serde(default)]
pub zoom: bool,
}
/// Request payload for `detach-client`.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct DetachClientRequest;
/// Extended request payload for `detach-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct DetachClientExtRequest {
/// The optional target-client identifier or `=`.
#[serde(default)]
pub target_client: Option<String>,
/// Whether all other clients should be detached instead.
#[serde(default)]
pub all_other_clients: bool,
/// The optional target session whose clients should all be detached.
#[serde(default)]
pub target_session: Option<SessionName>,
/// Whether targeted clients should be killed after detach.
#[serde(default)]
pub kill_on_detach: bool,
/// Optional client-local shell command to run before detaching.
#[serde(default)]
pub exec_command: Option<String>,
}
/// Request payload for `refresh-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RefreshClientRequest {
/// The optional target-client identifier or `=`.
#[serde(default)]
pub target_client: Option<String>,
/// Optional pan adjustment used with `-L`, `-R`, `-U`, or `-D`.
#[serde(default)]
pub adjustment: Option<u32>,
/// Whether client panning should be cleared.
#[serde(default)]
pub clear_pan: bool,
/// Whether the client view should pan left.
#[serde(default)]
pub pan_left: bool,
/// Whether the client view should pan right.
#[serde(default)]
pub pan_right: bool,
/// Whether the client view should pan up.
#[serde(default)]
pub pan_up: bool,
/// Whether the client view should pan down.
#[serde(default)]
pub pan_down: bool,
/// Whether only the status line should be redrawn.
#[serde(default)]
pub status_only: bool,
/// Whether the client clipboard should be queried.
#[serde(default)]
pub clipboard_query: bool,
/// Optional client-flag string from `-f`.
#[serde(default)]
pub flags: Option<String>,
/// Optional client-flag string from `-F`, which tmux treats as an alias for `-f`.
#[serde(default)]
pub flags_alias: Option<String>,
/// Optional control-mode subscription updates from `-A`.
#[serde(default)]
pub subscriptions: Vec<String>,
/// Optional control-mode subscription definitions from `-B`.
#[serde(default)]
pub subscriptions_format: Vec<String>,
/// Optional control-mode size string from `-C`.
#[serde(default)]
pub control_size: Option<String>,
/// Optional control-mode colour report request from `-r`.
#[serde(default)]
pub colour_report: Option<String>,
}
/// Request payload for `list-clients`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ListClientsRequest {
/// Optional custom output format.
#[serde(default)]
pub format: Option<String>,
/// Optional filter expression.
#[serde(default)]
pub filter: Option<String>,
/// Optional sort-order token.
#[serde(default)]
pub sort_order: Option<String>,
/// Whether the listing should be reversed.
#[serde(default)]
pub reversed: bool,
/// Optional session filter.
#[serde(default)]
pub target_session: Option<SessionName>,
}
/// Request payload for `suspend-client`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SuspendClientRequest {
/// The optional target-client identifier or `=`.
#[serde(default)]
pub target_client: Option<String>,
}