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

use rmux_proto::{
    DisplayMessageDurationMillis, DisplayMessageExtRequest, DisplayMessageRequest, Request,
    Response, ShowMessagesRequest, Target,
};

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

impl Connection {
    /// Sends a `display-message` request over the detached RPC channel.
    pub fn display_message(
        &mut self,
        target: Option<Target>,
        print: bool,
        message: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::DisplayMessage(DisplayMessageRequest {
            target,
            print,
            message,
            empty_target_context: false,
        }))
    }

    /// Sends a `display-message -c` request over the detached RPC channel.
    pub fn display_message_ext(
        &mut self,
        target: Option<Target>,
        print: bool,
        message: Option<String>,
        target_client: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::DisplayMessageExt(Box::new(
            DisplayMessageExtRequest {
                target,
                print,
                message,
                target_client,
                empty_target_context: false,
                duration_ms: None,
                ignore_input: false,
            },
        )))
    }

    /// Sends `display-message` with attached-overlay timing and input policy.
    pub fn display_message_with_options(
        &mut self,
        target: Option<Target>,
        print: bool,
        message: Option<String>,
        target_client: Option<String>,
        duration_ms: Option<DisplayMessageDurationMillis>,
        ignore_input: bool,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::DisplayMessageExt(Box::new(
            DisplayMessageExtRequest {
                target,
                print,
                message,
                target_client,
                empty_target_context: false,
                duration_ms,
                ignore_input,
            },
        )))
    }

    /// Sends a `show-messages` request over the detached RPC channel.
    pub fn show_messages(
        &mut self,
        jobs: bool,
        terminals: bool,
        target_client: Option<String>,
    ) -> Result<Response, ClientError> {
        self.roundtrip(&Request::ShowMessages(ShowMessagesRequest {
            jobs,
            terminals,
            target_client,
        }))
    }
}