objectiveai-sdk 2.1.0

ObjectiveAI SDK, definitions, and utilities
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

//! Wire shape for a plugin-emitted command-execution request.

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

/// Plugin requests the host execute a command. The host streams
/// every emission back into the plugin's stdin; plugins demultiplex
/// concurrent in-flight commands by matching against the echoed
/// `id` on each response line.
///
/// The constant `type:"command"` discriminator disambiguates this
/// variant from the rest of the untagged [`super::Output`] catch-all,
/// mirroring the `type:"error"` discriminator on
/// [`crate::cli::Error`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
#[schemars(rename = "cli.plugins.Command")]
pub struct Command {
    pub r#type: CommandType,
    /// Plugin-minted correlation id. Echoed by the host on every
    /// response line so the plugin can demux concurrent calls.
    pub id: String,
    pub command: String,
}

/// Single-variant discriminator for [`Command`]'s `type` field.
/// Always `"command"` on the wire.
#[derive(
    Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema,
)]
#[serde(rename_all = "snake_case")]
#[schemars(rename = "cli.plugins.CommandType")]
pub enum CommandType {
    Command,
}