over_there/core/msg/content/reply/

mod.rs

mod batch;
mod capabilities;
mod custom;
mod forward;
mod generic_error;
mod internal_debug;
mod io;
mod sequence;
mod version;

pub use batch::*;
pub use capabilities::*;
pub use custom::*;
pub use forward::*;
pub use generic_error::*;
pub use internal_debug::*;
pub use io::*;
pub use sequence::*;
pub use version::*;

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

// NOTE: Cannot adjacently tag as JsonSchema does not support it and
//       it leads to deserialization errors with enum variants without
//       any real arguments (empty struct doesn't fix)
#[derive(JsonSchema, Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
// #[serde(tag = "type")]
#[serde(tag = "type", content = "payload")]
pub enum Reply {
    /// Used when we want to NOT send a reply at all
    #[serde(skip)]
    Ignore,

    // ------------------------------------------------------------------------
    // Heartbeats are used to ensure remote instances are alive
    #[serde(rename = "heartbeat_reply")]
    #[allow(dead_code)]
    Heartbeat,

    // ------------------------------------------------------------------------
    // Version information to ensure that we don't have
    // conflicting functionality
    #[serde(rename = "version_reply")]
    Version(VersionArgs),

    // ------------------------------------------------------------------------
    // Capability information to convey what is available remotely, which
    // can differ based on enabled features at compile time
    #[serde(rename = "capabilities_reply")]
    Capabilities(CapabilitiesArgs),

    // ------------------------------------------------------------------------
    // Dir-based operations such as creating and listing entries
    /// This will be returned upon creating a directory
    #[serde(rename = "create_dir_reply")]
    DirCreated(DirCreatedArgs),

    /// This will be returned upon renaming a directory
    #[serde(rename = "rename_dir_reply")]
    DirRenamed(DirRenamedArgs),

    /// This will be returned upon removing a directory
    #[serde(rename = "remove_dir_reply")]
    DirRemoved(DirRemovedArgs),

    /// This will be returned upon collecting the list of files and directories
    /// at the provided path
    #[serde(rename = "list_dir_contents_reply")]
    DirContentsList(DirContentsListArgs),

    // ------------------------------------------------------------------------
    // File-based operations such as reading and writing
    /// This will be returned upon a file being opened or refreshed
    #[serde(rename = "open_file_reply")]
    FileOpened(FileOpenedArgs),

    /// This will be returned upon a file being closed
    #[serde(rename = "close_file_reply")]
    FileClosed(FileClosedArgs),

    /// This will be returned upon renaming a file
    #[serde(rename = "rename_unopened_file_reply")]
    UnopenedFileRenamed(UnopenedFileRenamedArgs),

    /// This will be returned upon renaming an open file
    #[serde(rename = "rename_file_reply")]
    FileRenamed(FileRenamedArgs),

    /// This will be returned upon removing a file
    #[serde(rename = "remove_unopened_file_reply")]
    UnopenedFileRemoved(UnopenedFileRemovedArgs),

    /// This will be returned upon removing an open file
    #[serde(rename = "remove_file_reply")]
    FileRemoved(FileRemovedArgs),

    /// This will be returned upon reading a file's contents
    #[serde(rename = "read_file_reply")]
    FileContents(FileContentsArgs),

    /// This will be returned upon writing a file's contents
    /// Contains the updated signature for the file
    #[serde(rename = "write_file_reply")]
    FileWritten(FileWrittenArgs),

    // ------------------------------------------------------------------------
    // Program execution operations such as running and streaming
    /// This will be returned upon starting a process on the server, indicating
    /// success and providing an id for sending stdin and receiving stdout/stderr
    #[serde(rename = "exec_proc_reply")]
    ProcStarted(ProcStartedArgs),

    /// This will be returned upon successfully writing to stdin
    #[serde(rename = "write_proc_stdin_reply")]
    ProcStdinWritten(ProcStdinWrittenArgs),

    /// This will be returned upon receiving stdout from a remote process on
    /// the server, if enabled when first executing
    #[serde(rename = "read_proc_stdout_reply")]
    ProcStdoutContents(ProcStdoutContentsArgs),

    /// This will be returned upon receiving stderr from a remote process on
    /// the server, if enabled when first executing
    #[serde(rename = "read_proc_stderr_reply")]
    ProcStderrContents(ProcStderrContentsArgs),

    /// This will be returned upon attempting to kill a process
    #[serde(rename = "kill_proc_reply")]
    ProcKilled(ProcKilledArgs),

    /// This will be returned reporting the status of the process, indicating
    /// if still running or if has completed (and the exit code)
    #[serde(rename = "read_proc_status_reply")]
    ProcStatus(ProcStatusArgs),

    // ------------------------------------------------------------------------
    // Miscellaneous, adhoc messages
    /// This will be returned upon encountering an error during evaluation
    #[serde(rename = "error_reply")]
    Error(ReplyError),

    /// This will be returned upon successfully evaluating a sequence of operations
    #[serde(rename = "sequence_reply")]
    Sequence(SequenceArgs),

    /// This will be returned upon successfully evaluating a batch of operations in parallel
    #[serde(rename = "batch_reply")]
    Batch(BatchArgs),

    /// This will be sent to either the client or server and the msg will be
    /// passed along to the associated address (if possible)
    #[serde(rename = "forward_reply")]
    Forward(ForwardArgs),

    /// This will be sent in either direction to provide a custom content
    /// that would be evaluated through user-implemented handlers
    #[serde(rename = "custom_reply")]
    Custom(CustomArgs),

    /// For debugging purposes when needing to query the state of client/server
    #[serde(rename = "internal_debug_reply")]
    InternalDebug(InternalDebugArgs),
}

impl crate::core::SchemaInfo for Reply {}

impl From<std::io::Error> for Reply {
    fn from(x: std::io::Error) -> Self {
        Self::Error(ReplyError::from(x))
    }
}

impl From<Box<dyn std::error::Error>> for Reply {
    fn from(x: Box<dyn std::error::Error>) -> Self {
        Self::Error(ReplyError::from(x))
    }
}

#[derive(JsonSchema, Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
#[serde(tag = "type")]
pub enum ReplyError {
    #[serde(rename = "generic_error")]
    Generic(GenericErrorArgs),

    #[serde(rename = "io_error")]
    Io(IoErrorArgs),

    #[serde(rename = "file_sig_changed_error")]
    FileSigChanged(FileSigChangedArgs),
}

impl crate::core::SchemaInfo for ReplyError {}

impl ToString for ReplyError {
    fn to_string(&self) -> String {
        match self {
            Self::Generic(args) => args.to_string(),
            Self::Io(args) => args.to_string(),
            Self::FileSigChanged(args) => args.to_string(),
        }
    }
}

impl From<String> for ReplyError {
    fn from(text: String) -> Self {
        Self::Generic(GenericErrorArgs::from(text))
    }
}

impl From<&str> for ReplyError {
    fn from(text: &str) -> Self {
        Self::from(String::from(text))
    }
}

impl From<Box<dyn std::error::Error>> for ReplyError {
    fn from(x: Box<dyn std::error::Error>) -> Self {
        Self::Generic(GenericErrorArgs::from(x))
    }
}

impl From<std::io::Error> for ReplyError {
    fn from(x: std::io::Error) -> Self {
        Self::Io(IoErrorArgs::from(x))
    }
}