Struct DescribeV1 

pub struct DescribeV1 {
    pub protocol_version: u32,
    pub plugin_id: String,
    pub plugin_version: String,
    pub min_osp_version: Option<String>,
    pub commands: Vec<DescribeCommandV1>,
}

describe payload emitted by a plugin that speaks protocol v1.

Fields

protocol_version: u32

Protocol version declared by the plugin.

plugin_id: String

Stable plugin identifier.

plugin_version: String

Plugin version string.

min_osp_version: Option<String>

Minimum osp-cli version required by the plugin, if any.

commands: Vec<DescribeCommandV1>

Top-level commands exported by the plugin.

Implementations

impl DescribeV1

pub fn from_clap_command( plugin_id: impl Into<String>, plugin_version: impl Into<String>, min_osp_version: Option<String>, command: Command, ) -> Self

Builds a v1 describe payload from a single clap command tree.

Only available with the clap cargo feature, which is enabled by default.

Examples

use clap::Command;
use osp_cli::core::plugin::DescribeV1;

let describe = DescribeV1::from_clap_command(
    "ldap",
    "0.1.0",
    None,
    Command::new("ldap").about("Directory lookups"),
);

assert_eq!(describe.plugin_id, "ldap");
assert_eq!(describe.commands[0].name, "ldap");

pub fn from_clap_commands( plugin_id: impl Into<String>, plugin_version: impl Into<String>, min_osp_version: Option<String>, commands: impl IntoIterator<Item = Command>, ) -> Self

Builds a v1 describe payload from multiple top-level clap commands.

Only available with the clap cargo feature, which is enabled by default.

Use this when one plugin executable exposes multiple top-level command roots.

Examples

use clap::Command;
use osp_cli::core::plugin::DescribeV1;

let describe = DescribeV1::from_clap_commands(
    "directory-tools",
    "0.1.0",
    None,
    [
        Command::new("ldap").about("Directory lookups"),
        Command::new("groups").about("Group lookups"),
    ],
);

assert_eq!(describe.plugin_id, "directory-tools");
assert_eq!(describe.commands.len(), 2);
assert_eq!(describe.commands[1].name, "groups");

pub fn validate_v1(&self) -> Result<(), String>

Validates the describe payload and returns an error string on protocol violations.

Hosts should do this before trusting plugin describe data enough to turn it into command catalogs, completion trees, or policy registries. Validation errors are returned as plain strings because protocol violations are currently treated as operator-facing diagnostics rather than a machine-matchable error taxonomy.

Examples

use osp_cli::core::plugin::{DescribeV1, PLUGIN_PROTOCOL_V1};

let describe = DescribeV1 {
    protocol_version: PLUGIN_PROTOCOL_V1,
    plugin_id: "ldap".to_string(),
    plugin_version: "0.1.0".to_string(),
    min_osp_version: None,
    commands: Vec::new(),
};

assert!(describe.validate_v1().is_ok());

let invalid = DescribeV1 {
    plugin_id: "   ".to_string(),
    ..describe.clone()
};
assert_eq!(invalid.validate_v1().unwrap_err(), "plugin_id must not be empty");

Trait Implementations

impl Clone for DescribeV1

fn clone(&self) -> DescribeV1

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeV1

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DescribeV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DescribeV1

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.