rmux-proto 0.1.0

RMUX detached IPC protocol DTOs, framing, and wire-safe error types.
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

use serde::{Deserialize, Serialize};

use super::CommandOutput;
use crate::{
    HookLifecycle, HookName, OptionName, OptionScopeSelector, ScopeSelector, SetOptionMode,
};

/// Response payload for `set-option`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SetOptionResponse {
    /// The applied scope.
    pub scope: ScopeSelector,
    /// The mutated option.
    pub option: OptionName,
    /// The mutation mode applied by the server.
    pub mode: SetOptionMode,
}

/// Response payload for string-based `set-option`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SetOptionByNameResponse {
    /// The applied scope.
    pub scope: OptionScopeSelector,
    /// The canonical option name.
    pub name: String,
    /// The mutation mode applied by the server.
    pub mode: SetOptionMode,
}

/// Response payload for `set-environment`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SetEnvironmentResponse {
    /// The applied scope.
    pub scope: ScopeSelector,
    /// The environment variable name that was mutated.
    pub name: String,
}

/// Response payload for `set-hook`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SetHookResponse {
    /// The applied scope.
    pub scope: ScopeSelector,
    /// The registered hook.
    pub hook: HookName,
    /// The registered lifecycle.
    pub lifecycle: HookLifecycle,
}

/// Response payload for `show-options`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ShowOptionsResponse {
    /// The selected option scope.
    pub scope: OptionScopeSelector,
    /// The pre-rendered stdout bytes for the CLI.
    pub output: CommandOutput,
}

impl ShowOptionsResponse {
    /// Returns the reusable stdout payload for the show command.
    #[must_use]
    pub fn command_output(&self) -> &CommandOutput {
        &self.output
    }
}

/// Response payload for `show-environment`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ShowEnvironmentResponse {
    /// The selected environment scope.
    pub scope: ScopeSelector,
    /// The pre-rendered stdout bytes for the CLI.
    pub output: CommandOutput,
}

impl ShowEnvironmentResponse {
    /// Returns the reusable stdout payload for the show command.
    #[must_use]
    pub fn command_output(&self) -> &CommandOutput {
        &self.output
    }
}

/// Response payload for `show-hooks`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ShowHooksResponse {
    /// The selected hook scope.
    pub scope: ScopeSelector,
    /// The pre-rendered stdout bytes for the CLI.
    pub output: CommandOutput,
}

impl ShowHooksResponse {
    /// Returns the reusable stdout payload for the show command.
    #[must_use]
    pub fn command_output(&self) -> &CommandOutput {
        &self.output
    }
}