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

use serde::{Deserialize, Serialize};

use super::{PaneAttributes, PaneColor, PaneGlyph};

/// One captured pane cell.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct PaneCell {
    /// Captured glyph payload and display-width metadata.
    #[serde(default)]
    pub glyph: PaneGlyph,
    /// Cell attribute bitset.
    #[serde(default)]
    pub attributes: PaneAttributes,
    /// Foreground color.
    #[serde(default)]
    pub foreground: PaneColor,
    /// Background color.
    #[serde(default)]
    pub background: PaneColor,
    /// Underline color.
    #[serde(default)]
    pub underline: PaneColor,
}

impl PaneCell {
    /// Creates a cell with the given glyph and default style.
    #[must_use]
    pub fn new(glyph: PaneGlyph) -> Self {
        Self {
            glyph,
            ..Self::default()
        }
    }

    /// Creates a blank, non-padding cell with default style.
    #[must_use]
    pub fn blank() -> Self {
        Self::new(PaneGlyph::blank())
    }

    /// Creates a padding cell for the trailing column of a wide glyph.
    #[must_use]
    pub fn padding() -> Self {
        Self::new(PaneGlyph::padding())
    }

    /// Returns whether this cell is wide-glyph padding.
    #[must_use]
    pub const fn is_padding(&self) -> bool {
        self.glyph.is_padding()
    }

    /// Returns the stored glyph text payload.
    #[must_use]
    pub fn text(&self) -> &str {
        &self.glyph.text
    }
}

impl Default for PaneCell {
    fn default() -> Self {
        Self {
            glyph: PaneGlyph::blank(),
            attributes: PaneAttributes::EMPTY,
            foreground: PaneColor::Default,
            background: PaneColor::Default,
            underline: PaneColor::Default,
        }
    }
}