command.rs

/// Top-level IPC command sent from `appclictl` to `appclid`.
///
/// Commands are serialised with [`encode`](crate::protocol::encode) and deserialised with
/// [`decode`](crate::protocol::decode).
///
/// # Example
///
/// ```
/// use appcli::protocol::{Command, decode, encode};
///
/// let cmd = Command::Ping;
/// let json = encode(&cmd).expect("encode should succeed");
/// assert_eq!(decode(&json).expect("decode should succeed"), cmd);
/// ```
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case", tag = "command")]
pub enum Command {
    /// Check whether the daemon is alive. Returns [`crate::protocol::ResponseBody::Pong`].
    Ping,

    /// Ask the daemon to shut down gracefully.
    Shutdown,

    /// A config sub-command (show / reload).
    Config(ConfigAction),
}

/// Config-related sub-commands that can be sent to the daemon.
///
/// # Example
///
/// ```
/// use appcli::protocol::{Command, ConfigAction, decode, encode};
///
/// let cmd = Command::Config(ConfigAction::Reload {
///     path: Some("/etc/appcli/config.yaml".into()),
/// });
/// let json = encode(&cmd).expect("encode should succeed");
/// assert_eq!(decode(&json).expect("decode should succeed"), cmd);
/// ```
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case", tag = "action")]
pub enum ConfigAction {
    /// Request a dump of the daemon's current runtime configuration.
    Show,

    /// Hot-reload the daemon's configuration.
    ///
    /// If `path` is [`Some`], reload from that file; otherwise re-read the
    /// original config file (or return an error if none was loaded).
    Reload {
        /// Path to load the new configuration from, or `None` to reuse the current path.
        path: Option<String>,
    },
}