rmux-client 0.10.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
162
163
164
165
166
167
168
169

use rmux_proto::{
    CapturePaneRequest, CapturePaneTargetActionRequest, ClearHistoryRequest, DeleteBufferRequest,
    ListBuffersRequest, LoadBufferRequest, PaneTarget, PasteBufferRequest, Request, Response,
    SaveBufferRequest, SetBufferRequest, ShowBufferRequest,
};
use std::path::{Path, PathBuf};

use crate::{connection::Connection, ClientError};

impl Connection {
    /// Sends a `set-buffer` request over the detached RPC channel.
    pub fn set_buffer(
        &mut self,
        name: Option<String>,
        content: Vec<u8>,
        append: bool,
        new_name: Option<String>,
        set_clipboard: bool,
    ) -> Result<Response, ClientError> {
        self.set_buffer_target_client(name, content, append, new_name, set_clipboard, None)
    }

    /// Sends a target-client-aware `set-buffer` request.
    #[allow(clippy::too_many_arguments)]
    pub fn set_buffer_target_client(
        &mut self,
        name: Option<String>,
        content: Vec<u8>,
        append: bool,
        new_name: Option<String>,
        set_clipboard: bool,
        target_client: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::SetBuffer(Box::new(SetBufferRequest {
            name,
            content,
            append,
            new_name,
            set_clipboard,
            target_client,
        })))
    }

    /// Sends a `show-buffer` request over the detached RPC channel.
    pub fn show_buffer(&mut self, name: Option<String>) -> Result<Response, ClientError> {
        self.roundtrip(&Request::ShowBuffer(ShowBufferRequest { name }))
    }

    /// Sends a `paste-buffer` request over the detached RPC channel.
    #[allow(clippy::too_many_arguments)]
    pub fn paste_buffer(
        &mut self,
        name: Option<String>,
        target: PaneTarget,
        delete_after: bool,
        separator: Option<String>,
        linefeed: bool,
        raw: bool,
        bracketed: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::PasteBuffer(Box::new(PasteBufferRequest {
            name,
            target,
            delete_after,
            separator,
            linefeed,
            raw,
            bracketed,
        })))
    }

    /// Sends a `list-buffers` request over the detached RPC channel.
    pub fn list_buffers(
        &mut self,
        format: Option<String>,
        filter: Option<String>,
        sort_order: Option<String>,
        reversed: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::ListBuffers(ListBuffersRequest {
            format,
            filter,
            sort_order,
            reversed,
        }))
    }

    /// Sends a `delete-buffer` request over the detached RPC channel.
    pub fn delete_buffer(&mut self, name: Option<String>) -> Result<Response, ClientError> {
        self.roundtrip(&Request::DeleteBuffer(DeleteBufferRequest { name }))
    }

    /// Sends a `load-buffer` request over the detached RPC channel.
    pub fn load_buffer(
        &mut self,
        path: String,
        name: Option<String>,
        set_clipboard: bool,
    ) -> Result<Response, ClientError> {
        self.load_buffer_target_client(path, name, set_clipboard, None)
    }

    /// Sends a target-client-aware `load-buffer` request.
    pub fn load_buffer_target_client(
        &mut self,
        path: String,
        name: Option<String>,
        set_clipboard: bool,
        target_client: Option<String>,
    ) -> Result<Response, ClientError> {
        let cwd = caller_cwd_for_path(&path)?;
        self.roundtrip(&Request::LoadBuffer(Box::new(LoadBufferRequest {
            path,
            cwd,
            name,
            set_clipboard,
            target_client,
        })))
    }

    /// Sends a `save-buffer` request over the detached RPC channel.
    pub fn save_buffer(
        &mut self,
        path: String,
        name: Option<String>,
        append: bool,
    ) -> Result<Response, ClientError> {
        let cwd = caller_cwd_for_path(&path)?;
        self.roundtrip(&Request::SaveBuffer(SaveBufferRequest {
            path,
            cwd,
            name,
            append,
        }))
    }

    /// Sends a `capture-pane` request over the detached RPC channel.
    pub fn capture_pane(&mut self, request: CapturePaneRequest) -> Result<Response, ClientError> {
        self.roundtrip(&Request::CapturePane(Box::new(request)))
    }

    /// Sends a `capture-pane` request with server-side target resolution.
    pub fn capture_pane_target_action(
        &mut self,
        request: CapturePaneTargetActionRequest,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::CapturePaneTargetAction(Box::new(request)))
    }

    /// Sends a `clear-history` request over the detached RPC channel.
    pub fn clear_history(
        &mut self,
        target: PaneTarget,
        reset_hyperlinks: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::ClearHistory(ClearHistoryRequest {
            target,
            reset_hyperlinks,
        }))
    }
}

fn caller_cwd_for_path(path: &str) -> Result<Option<PathBuf>, ClientError> {
    if Path::new(path).is_absolute() {
        Ok(None)
    } else {
        std::env::current_dir().map(Some).map_err(Into::into)
    }
}