tmux-client 0.1.0-alpha.1

Typed asynchronous Rust client for tmux
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
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
//! Session snapshots, hierarchy traversal, and mutations.

use std::collections::{BTreeMap, BTreeSet};
use std::ffi::OsString;
use std::future::Future;

use crate::{
    AttachedClient, Client, Command, Error, NewWindow, ObjectKind, OptionMap, OptionScope,
    OptionValue, Pane, Result, Server, SessionId, SessionName, SessionSnapshot, SparseOptionMap,
    TmuxText, Window, WindowId, WindowTarget,
};

/// A tmux session handle with an owned snapshot.
#[derive(Clone, Debug)]
pub struct Session {
    server: Server,
    id: SessionId,
    name: Option<SessionName>,
    snapshot: SessionSnapshot,
}

impl Session {
    pub(crate) fn from_row(server: Server, row: BTreeMap<&'static str, TmuxText>) -> Result<Self> {
        let snapshot = SessionSnapshot::new(row);
        let id = snapshot.id()?.ok_or_else(|| Error::Decode {
            context: "session row",
            message: "session_id was empty".to_owned(),
        })?;
        let name = snapshot.name()?;
        Ok(Self {
            server,
            id,
            name,
            snapshot,
        })
    }

    /// Resolves the session containing the pane named by `TMUX_PANE`.
    pub async fn from_environment() -> Result<Self> {
        Server::from_environment()?
            .pane_from_environment()
            .await?
            .session()
            .await
    }

    /// Returns the immutable tmux ID.
    #[must_use]
    pub const fn id(&self) -> SessionId {
        self.id
    }

    /// Returns the name captured in the current snapshot.
    #[must_use]
    pub const fn name(&self) -> Option<&SessionName> {
        self.name.as_ref()
    }

    /// Returns the owned snapshot.
    #[must_use]
    pub const fn snapshot(&self) -> &SessionSnapshot {
        &self.snapshot
    }

    /// Returns the server handle used by this object.
    #[must_use]
    pub const fn server(&self) -> &Server {
        &self.server
    }

    /// Replaces this object's state with a fresh snapshot.
    pub async fn refresh(&mut self) -> Result<()> {
        *self = self.server.session(self.id).await?;
        Ok(())
    }

    /// Runs an arbitrary tmux command targeted at this session.
    pub async fn cmd(&self, command: Command) -> Result<crate::CommandResult> {
        self.server.cmd(command.target(self.id)).await
    }

    /// Lists window links owned by this session.
    pub async fn windows(&self) -> Result<Vec<Window>> {
        Ok(self
            .server
            .windows()
            .await?
            .into_iter()
            .filter(|window| window.session_id() == self.id)
            .collect())
    }

    /// Lists windows, returning an empty collection on failure.
    pub async fn windows_or_empty(&self) -> Vec<Window> {
        self.windows().await.unwrap_or_default()
    }

    /// Lists every pane belonging to this session.
    pub async fn panes(&self) -> Result<Vec<Pane>> {
        Ok(self
            .server
            .panes()
            .await?
            .into_iter()
            .filter(|pane| pane.session_id() == self.id)
            .collect())
    }

    /// Lists panes, returning an empty collection on failure.
    pub async fn panes_or_empty(&self) -> Vec<Pane> {
        self.panes().await.unwrap_or_default()
    }

    /// Returns the active pane in this session's active window.
    pub async fn active_pane(&self) -> Result<Pane> {
        self.active_window().await?.active_pane().await
    }

    /// Returns the active window link.
    pub async fn active_window(&self) -> Result<Window> {
        let mut active = Vec::new();
        for window in self.windows().await? {
            if window.snapshot().active()? == Some(true) {
                active.push(window);
            }
        }
        match active.len() {
            0 => Err(Error::ObjectNotFound {
                kind: ObjectKind::Window,
                target: format!("active window in {}", self.id),
            }),
            1 => active.into_iter().next().ok_or_else(|| Error::Decode {
                context: "active window",
                message: "single result disappeared".to_owned(),
            }),
            count => Err(Error::MultipleObjects {
                kind: ObjectKind::Window,
                count,
                query: format!("active windows in {}", self.id),
            }),
        }
    }

    /// Resolves one window ID within this session.
    pub async fn window(&self, id: WindowId) -> Result<Window> {
        self.windows()
            .await?
            .into_iter()
            .find(|window| window.id() == id)
            .ok_or_else(|| Error::ObjectNotFound {
                kind: ObjectKind::Window,
                target: format!("{id} in {}", self.id),
            })
    }

    /// Lists clients currently attached to this session.
    pub async fn clients(&self) -> Result<Vec<Client>> {
        let name = self.name().map(ToString::to_string);
        Ok(self
            .server
            .clients()
            .await?
            .into_iter()
            .filter(|client| client.session_name().map(ToString::to_string) == name)
            .collect())
    }

    /// Creates a window in this session.
    pub async fn new_window(&self, options: NewWindow) -> Result<Window> {
        Window::create(self, options).await
    }

    /// Creates a temporary window, runs an async operation, and attempts cleanup.
    pub async fn with_window<F, Fut, T>(&self, options: NewWindow, operation: F) -> Result<T>
    where
        F: FnOnce(Window) -> Fut,
        Fut: Future<Output = Result<T>>,
    {
        let window = self.new_window(options).await?;
        let cleanup = window.clone();
        let outcome = operation(window).await;
        let cleanup_result = cleanup.kill().await;
        match (outcome, cleanup_result) {
            (Ok(value), Ok(())) => Ok(value),
            (Ok(_), Err(source)) => Err(Error::Cleanup {
                operation: "with_window",
                source: Box::new(source),
            }),
            (Err(source), _) => Err(source),
        }
    }

    /// Renames the session and refreshes the snapshot.
    pub async fn rename(&mut self, name: impl Into<String>) -> Result<()> {
        let name = SessionName::new(name)?;
        self.server
            .checked(
                "rename session",
                Command::new("rename-session")
                    .target(self.id)
                    .arg(name.to_string()),
            )
            .await?;
        self.refresh().await
    }

    /// Selects this session for the invoking client.
    pub async fn select(&self) -> Result<()> {
        self.server
            .checked(
                "select session",
                Command::new("switch-client").target(self.id),
            )
            .await
            .map(|_| ())
    }

    /// Locks clients attached to this session.
    pub async fn lock(&self) -> Result<()> {
        self.server
            .checked("lock session", Command::new("lock-session").target(self.id))
            .await
            .map(|_| ())
    }

    /// Kills one selected window in this session.
    pub async fn kill_window(&self, target: impl Into<WindowTarget>) -> Result<()> {
        self.server
            .checked(
                "kill session window",
                Command::new("kill-window").target(target.into()),
            )
            .await
            .map(|_| ())
    }

    /// Selects a window link in this session.
    pub async fn select_window(&self, window: impl Into<WindowTarget>) -> Result<()> {
        self.server
            .checked(
                "select window",
                Command::new("select-window").target(window.into()),
            )
            .await
            .map(|_| ())
    }

    /// Selects the next window.
    pub async fn next_window(&self, alert: bool) -> Result<()> {
        let command = if alert {
            Command::new("next-window").arg("-a")
        } else {
            Command::new("next-window")
        };
        self.server
            .checked("next window", command.target(self.id))
            .await
            .map(|_| ())
    }

    /// Selects the previous window.
    pub async fn previous_window(&self, alert: bool) -> Result<()> {
        let command = if alert {
            Command::new("previous-window").arg("-a")
        } else {
            Command::new("previous-window")
        };
        self.server
            .checked("previous window", command.target(self.id))
            .await
            .map(|_| ())
    }

    /// Selects the last active window.
    pub async fn last_window(&self) -> Result<()> {
        self.server
            .checked("last window", Command::new("last-window").target(self.id))
            .await
            .map(|_| ())
    }

    /// Renumbers this session's window links.
    pub async fn renumber_windows(&self) -> Result<()> {
        self.server
            .checked(
                "renumber windows",
                Command::new("move-window").arg("-r").target(self.id),
            )
            .await
            .map(|_| ())
    }

    /// Detaches every client attached to this session.
    pub async fn detach_clients(&self) -> Result<()> {
        self.server
            .checked(
                "detach session clients",
                Command::new("detach-client")
                    .arg("-s")
                    .arg(self.id.to_string()),
            )
            .await
            .map(|_| ())
    }

    /// Detaches all clients and runs a shell command for each detached client.
    pub async fn detach_clients_with_command(&self, shell_command: OsString) -> Result<()> {
        self.server
            .checked(
                "detach session clients",
                Command::new("detach-client")
                    .arg("-s")
                    .arg(self.id.to_string())
                    .arg("-E")
                    .sensitive_arg(shell_command),
            )
            .await
            .map(|_| ())
    }

    /// Applies extended `kill-session` flags.
    pub async fn kill_with(&self, all_except: bool, clear_alerts: bool, group: bool) -> Result<()> {
        if group {
            self.server
                .version()
                .await?
                .require("kill session group", crate::ReleaseVersion::new(3, 7, None))?;
        }
        let mut command = Command::new("kill-session").target(self.id);
        if all_except {
            command = command.arg("-a");
        }
        if clear_alerts {
            command = command.arg("-C");
        }
        if group {
            command = command.arg("-g");
        }
        self.server
            .checked("kill session", command)
            .await
            .map(|_| ())
    }

    /// Starts an interactive attachment.
    pub fn attach(&self, read_only: bool) -> Result<AttachedClient> {
        self.server.attach(self.id, read_only)
    }

    /// Destroys the session. Dropping the handle does not call this method.
    pub async fn kill(&self) -> Result<()> {
        self.server
            .checked("kill session", Command::new("kill-session").target(self.id))
            .await
            .map(|_| ())
    }

    /// Shows options at session scope.
    pub async fn options(&self) -> Result<OptionMap> {
        self.server
            .show_options(OptionScope::Session, Some(&self.id.to_string()))
            .await
    }

    /// Shows sparse options and hooks at session scope.
    pub async fn sparse_options(&self) -> Result<SparseOptionMap> {
        self.server
            .show_sparse_options(OptionScope::Session, Some(&self.id.to_string()))
            .await
    }

    /// Sets a session option.
    pub async fn set_option(&self, name: &str, value: &OptionValue, append: bool) -> Result<()> {
        self.server
            .set_option(
                OptionScope::Session,
                Some(&self.id.to_string()),
                name,
                value,
                append,
            )
            .await
    }

    /// Unsets a session option.
    pub async fn unset_option(&self, name: &str) -> Result<()> {
        self.server
            .unset_option(OptionScope::Session, Some(&self.id.to_string()), name)
            .await
    }

    /// Shows this session's environment. Removed entries have a `None` value.
    pub async fn environment(&self) -> Result<BTreeMap<String, Option<TmuxText>>> {
        let result = self
            .server
            .checked(
                "show session environment",
                Command::new("show-environment").target(self.id),
            )
            .await?;
        crate::server::parse_environment(result.stdout().as_bytes())
    }

    /// Returns one session environment entry.
    ///
    /// The outer option distinguishes an unknown name; the inner option is
    /// `None` when tmux records the name as explicitly removed.
    pub async fn environment_entry(&self, name: &str) -> Result<Option<Option<TmuxText>>> {
        crate::server::validate_name("environment name", name)?;
        Ok(self.environment().await?.remove(name))
    }

    /// Sets a session environment variable.
    pub async fn set_environment(&self, name: &str, value: impl Into<OsString>) -> Result<()> {
        self.set_environment_with(name, value, false, false).await
    }

    /// Sets a session environment variable with format expansion or hidden storage.
    pub async fn set_environment_with(
        &self,
        name: &str,
        value: impl Into<OsString>,
        expand_formats: bool,
        hidden: bool,
    ) -> Result<()> {
        crate::server::validate_name("environment name", name)?;
        let mut command = Command::new("set-environment").target(self.id);
        if expand_formats {
            command = command.arg("-F");
        }
        if hidden {
            command = command.arg("-h");
        }
        self.server
            .checked(
                "set session environment",
                command.arg(name).sensitive_arg(value),
            )
            .await
            .map(|_| ())
    }

    /// Unsets a session environment variable.
    pub async fn unset_environment(&self, name: &str) -> Result<()> {
        crate::server::validate_name("environment name", name)?;
        self.server
            .checked(
                "unset session environment",
                Command::new("set-environment")
                    .arg("-u")
                    .target(self.id)
                    .arg(name),
            )
            .await
            .map(|_| ())
    }

    /// Marks a session environment variable as removed for future child processes.
    pub async fn remove_environment(&self, name: &str) -> Result<()> {
        crate::server::validate_name("environment name", name)?;
        self.server
            .checked(
                "remove session environment",
                Command::new("set-environment")
                    .arg("-r")
                    .target(self.id)
                    .arg(name),
            )
            .await
            .map(|_| ())
    }

    /// Returns all distinct window IDs linked into this session.
    pub async fn window_ids(&self) -> Result<BTreeSet<WindowId>> {
        Ok(self
            .windows()
            .await?
            .into_iter()
            .map(|window| window.id())
            .collect())
    }
}

impl PartialEq for Session {
    fn eq(&self, other: &Self) -> bool {
        self.id == other.id && self.server.config() == other.server.config()
    }
}

impl Eq for Session {}