rmux-server 0.10.0

Tokio daemon and request dispatcher 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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

#![forbid(unsafe_code)]
#![deny(missing_docs)]
#![deny(clippy::await_holding_lock)]

//! Tokio-based detached RPC server for RMUX.

#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod automatic_rename;
#[cfg(any(unix, windows))]
mod buffer_file_io;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod client_flags;
#[cfg(any(unix, windows))]
mod client_format;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod client_names;
#[cfg(any(unix, windows))]
mod clipboard_protocol;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod clock_mode;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod control;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod control_mode;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod control_notifications;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod copy_mode;
mod daemon;
#[cfg(any(unix, windows))]
mod diagnostic_log;
#[cfg(any(unix, windows))]
mod foreground_probe;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod format_runtime;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod handler;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod handler_support;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod hook_compat;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod hook_runtime;
#[cfg(any(unix, windows))]
mod host_name;
#[cfg(any(unix, windows))]
mod input_keys;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod key_table;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod keys;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod legacy_command;
#[cfg(any(unix, windows))]
mod lifecycle_commit_order;
#[cfg(any(unix, windows))]
mod limits;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod listener;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod listener_options;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod listener_signals;
#[cfg(any(unix, windows))]
mod mouse;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod outer_terminal;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_indices;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_io;
#[cfg(unix)]
mod pane_reader_runtime;
#[cfg(any(unix, windows))]
mod pane_recovery;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_screen_state;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_scrollbar;
#[cfg(any(unix, windows))]
mod pane_state_journal;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_terminal_lookup;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_terminal_process;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_terminals;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_transcript;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod pane_visible_geometry;
#[cfg(any(unix, windows))]
mod perf_instrument;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod renderer;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod server_access;
mod signals;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod socket_cleanup;
#[cfg(any(unix, windows))]
mod status_jobs;
#[cfg(any(unix, windows))]
mod status_lines;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod status_ranges;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod terminal;
#[cfg(test)]
mod test_env;
#[cfg(test)]
mod test_shell;
#[cfg(any(unix, windows))]
mod tmux_shim;
#[cfg(unix)]
mod unix_socket;
#[cfg(unix)]
mod unix_socket_access;
#[cfg(any(unix, windows))]
#[cfg_attr(windows, allow(dead_code))]
mod wait_for;
#[cfg(all(any(unix, windows), feature = "web"))]
mod web;
// Console-input retry policy is plain `io::Error` logic with no Win32 calls:
// compile it in test builds on every platform so the policy stays covered.
#[cfg(any(windows, test))]
mod windows_console_input;

/// Fuzzing entry points for protocol parsers.
#[cfg(all(any(unix, windows), feature = "web", feature = "fuzzing"))]
#[doc(hidden)]
pub mod fuzzing {
    /// Feeds arbitrary bytes into the server-side share client-frame parser.
    pub fn websocket_client_frame(data: &[u8]) {
        crate::web::fuzz_client_frame(data);
    }
}

pub use daemon::{
    default_socket_path, ConfigFileSelection, ConfigLoadOptions, DaemonConfig, ServerDaemon,
    ServerHandle,
};

/// Runs the private platform FIFO reader helper when its hidden invocation flag is present.
///
/// This is an implementation detail shared by the full `rmux` and `rmux-daemon`
/// entrypoints. Normal invocations return `None`; helper invocations write the
/// FIFO payload to standard output and return the process exit code. Calling
/// this function during normal process startup also advertises the current
/// executable as a helper host for embedded [`ServerDaemon`] instances.
#[cfg(unix)]
#[doc(hidden)]
pub fn run_internal_fifo_reader_helper<I>(arguments: I) -> Option<i32>
where
    I: IntoIterator<Item = std::ffi::OsString>,
{
    buffer_file_io::run_internal_fifo_reader_helper(arguments)
}