Struct DescribeCommandV1 

pub struct DescribeCommandV1 {
    pub name: String,
    pub about: String,
    pub auth: Option<DescribeCommandAuthV1>,
    pub args: Vec<DescribeArgV1>,
    pub flags: BTreeMap<String, DescribeFlagV1>,
    pub subcommands: Vec<DescribeCommandV1>,
}

Recursive command description used in plugin metadata.

Fields

name: String

Command name exposed by the plugin.

about: String

Short help text for the command.

auth: Option<DescribeCommandAuthV1>

Optional authorization metadata for the command.

args: Vec<DescribeArgV1>

Positional argument descriptions in declaration order.

flags: BTreeMap<String, DescribeFlagV1>

Flag descriptions keyed by protocol flag spelling.

subcommands: Vec<DescribeCommandV1>

Nested subcommands under this command.

Implementations

impl DescribeCommandV1

pub fn command_policy(&self, path: CommandPath) -> Option<CommandPolicy>

Converts command auth metadata into an internal command policy for path.

This is the host-side bridge from wire-format describe data into the runtime policy evaluator in crate::core::command_policy.

Required capabilities and feature flags are normalized by trimming surrounding whitespace and lowercasing the values before they enter the runtime policy.

Examples

use osp_cli::core::command_policy::{CommandPath, VisibilityMode};
use osp_cli::core::plugin::{
    DescribeCommandAuthV1, DescribeCommandV1, DescribeVisibilityModeV1,
};
use std::collections::BTreeMap;

let command = DescribeCommandV1 {
    name: "decide".to_string(),
    about: String::new(),
    auth: Some(DescribeCommandAuthV1 {
        visibility: Some(DescribeVisibilityModeV1::CapabilityGated),
        required_capabilities: vec![" Orch.Approval.Decide ".to_string()],
        feature_flags: vec![" Review ".to_string()],
    }),
    args: Vec::new(),
    flags: BTreeMap::new(),
    subcommands: Vec::new(),
};

let policy = command
    .command_policy(CommandPath::new(["orch", "approval", "decide"]))
    .unwrap();

assert_eq!(policy.visibility, VisibilityMode::CapabilityGated);
assert!(policy
    .required_capabilities
    .contains("orch.approval.decide"));
assert!(policy.feature_flags.contains("review"));

impl DescribeCommandV1

pub fn from_clap(command: Command) -> Self

Converts a clap command into a protocol v1 command description.

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

Use this when the surrounding plugin metadata is assembled elsewhere but one command tree should still come from clap.

Examples

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

let command = DescribeCommandV1::from_clap(
    Command::new("ldap")
        .about("Directory lookups")
        .subcommand(Command::new("user").about("Lookup one user")),
);

assert_eq!(command.name, "ldap");
assert_eq!(command.subcommands[0].name, "user");

Trait Implementations

impl Clone for DescribeCommandV1

fn clone(&self) -> DescribeCommandV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeCommandV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DescribeCommandV1

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CommandDef> for DescribeCommandV1

fn from(command: &CommandDef) -> Self

Converts to this type from the input type.

impl From<&DescribeCommandV1> for CommandDef

fn from(command: &DescribeCommandV1) -> Self

Converts to this type from the input type.

impl Serialize for DescribeCommandV1

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

where __S: Serializer,

Serialize this value into the given Serde serializer.