rmux-sdk 0.6.1

Public, daemon-backed Rust SDK for the RMUX terminal multiplexer (facade, ensure-session, snapshots, events, detach helpers).
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

use rmux_proto::{PaneTargetRef, WebShareListener, WebShareScope};

/// Redacted metadata for an active browser-visible pane or session share.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WebShareSummary {
    /// Opaque share id.
    pub id: String,
    /// Shared pane or session scope.
    pub scope: WebShareScope,
    /// Redacted spectator URL, if available.
    pub spectator_url_redacted: Option<String>,
    /// Whether this share has an operator URL.
    pub operator: bool,
    /// Whether this share has a spectator URL.
    pub spectator: bool,
    /// Active spectator client count.
    pub active_spectators: u16,
    /// Active operator client count.
    pub active_operators: u16,
    /// Maximum spectator clients allowed, when capped.
    pub max_spectators: Option<u16>,
    /// Maximum operator clients allowed, when capped.
    pub max_operators: Option<u16>,
    /// Expiration timestamp in UNIX seconds.
    pub expires_at_unix: Option<u64>,
    /// Whether the daemon kills the target session when this share expires.
    pub kill_session_on_expire: bool,
}

impl WebShareSummary {
    /// Returns the pane target when this is a single-pane share.
    #[must_use]
    pub fn pane_target(&self) -> Option<&PaneTargetRef> {
        match &self.scope {
            WebShareScope::Pane(target) => Some(target),
            WebShareScope::Session(_) => None,
        }
    }
}

impl From<rmux_proto::WebShareSummary> for WebShareSummary {
    fn from(value: rmux_proto::WebShareSummary) -> Self {
        Self {
            id: value.share_id,
            scope: value.scope,
            spectator_url_redacted: value.spectator_url,
            operator: value.operator,
            spectator: value.spectator,
            active_spectators: value.active_spectators,
            active_operators: value.active_operators,
            max_spectators: value.max_spectators,
            max_operators: value.max_operators,
            expires_at_unix: value.expires_at_unix,
            kill_session_on_expire: value.kill_session_on_expire,
        }
    }
}

/// Web-share listener configuration reported by the daemon.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WebConfigInfo {
    /// Listener host.
    pub host: String,
    /// Listener port.
    pub port: u16,
    /// Origin used by the web-share frontend.
    pub frontend_origin: String,
}

impl From<WebShareListener> for WebConfigInfo {
    fn from(value: WebShareListener) -> Self {
        Self {
            host: value.host,
            port: value.port,
            frontend_origin: value.frontend_origin,
        }
    }
}