acpx 0.1.0

Simple Rust library and tooling for building on ACP.
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use std::io;

use thiserror::Error;

/// The crate-wide result type.
pub type Result<T, E = Error> = std::result::Result<T, E>;

/// Errors surfaced by `acpx`.
#[derive(Debug, Error)]
pub enum Error {
    /// The requested agent launch mode is not supported by this crate version.
    #[error(transparent)]
    UnsupportedLaunch(#[from] UnsupportedLaunch),

    /// Spawning the agent subprocess failed.
    #[error("failed to spawn agent process")]
    SpawnProcess {
        /// The underlying I/O error from process creation.
        #[source]
        source: io::Error,
    },

    /// The requested local launcher is not installed or not on `PATH`.
    #[error("launcher `{launcher}` was not found")]
    MissingLauncher {
        /// The missing launcher or executable name.
        launcher: String,
        /// The underlying I/O error from process creation.
        #[source]
        source: io::Error,
    },

    /// The spawned agent process did not expose a piped stdin handle.
    #[error("agent process stdin was not captured")]
    MissingChildStdin,

    /// The spawned agent process did not expose a piped stdout handle.
    #[error("agent process stdout was not captured")]
    MissingChildStdout,

    /// ACP request, response, or transport handling failed.
    #[error(transparent)]
    Protocol(#[from] agent_client_protocol::Error),

    /// The connection has already been closed.
    #[error("connection is closed")]
    Closed,

    /// Waiting for the agent process to exit failed.
    #[error("failed to wait for agent process exit")]
    WaitForProcess {
        /// The underlying I/O error from waiting on the child process.
        #[source]
        source: io::Error,
    },

    /// Terminating the agent process failed.
    #[error("failed to terminate agent process")]
    KillProcess {
        /// The underlying I/O error from killing the child process.
        #[source]
        source: io::Error,
    },

    /// The ACP I/O task ended unexpectedly.
    #[error("acp connection io task ended unexpectedly")]
    IoTaskTerminated,
}

/// Launch strategies that are intentionally unsupported in `acpx` v0.
#[derive(Debug, Clone, PartialEq, Eq, Error)]
pub enum UnsupportedLaunch {
    /// The official registry describes a downloadable binary distribution.
    #[error("binary registry distributions are not supported in v0")]
    BinaryDistribution,

    /// The registry or manual server definition uses a launcher that is not
    /// connectable by this crate version.
    #[error("launch command `{command}` is not supported in v0")]
    UnsupportedCommand {
        /// The unsupported command or launcher identifier.
        command: String,
    },
}

#[cfg(test)]
mod tests {
    use std::io;

    use super::{Error, UnsupportedLaunch};

    #[test]
    fn unsupported_launch_messages_are_stable() {
        assert_eq!(
            UnsupportedLaunch::BinaryDistribution.to_string(),
            "binary registry distributions are not supported in v0"
        );
        assert_eq!(
            UnsupportedLaunch::UnsupportedCommand {
                command: "brew".into()
            }
            .to_string(),
            "launch command `brew` is not supported in v0"
        );
        assert_eq!(
            Error::MissingLauncher {
                launcher: "npx".into(),
                source: io::Error::from(io::ErrorKind::NotFound),
            }
            .to_string(),
            "launcher `npx` was not found"
        );
    }
}