Struct Describe 

pub struct Describe {
    pub description: String,
    pub version: Version,
    pub stability: Stability,
    pub min_dispatcher_version: Version,
    pub platforms: Vec<Platform>,
    pub requires_cargo_workspace: bool,
    pub capabilities: Vec<CapabilityDescriptor>,
}

Plugin self-description payload.

Same shape as crate::manifest::Manifest; the two share a JSON schema.

Fields

description: String

One-line summary, max 80 chars.

version: Version

Plugin semver.

stability: Stability

Stability tier.

min_dispatcher_version: Version

Minimum dispatcher semver this plugin requires.

platforms: Vec<Platform>

Supported operating systems.

requires_cargo_workspace: bool

Whether the plugin requires a cargo workspace context.

capabilities: Vec<CapabilityDescriptor>

Product capabilities contributed by this plugin.

Implementations

impl Describe

pub fn emit_stdout(&self) -> Result<()>

Print this Describe as a single line of JSON to stdout, terminated by a newline.

Errors

Returns Error::JsonParse if serialization fails or Error::Io if writing to stdout fails.

pub fn handle_arg0_describe( &self, args: impl IntoIterator<Item = OsString>, ) -> Option<ExitCode>

If the first non-program argument is __describe, emit this Describe and return Some(ExitCode::Ok). Otherwise return None so the caller can continue with normal argument parsing.

Plugins MUST call this before their main argument parser runs to avoid clap rejecting the unknown subcommand.

Errors

Returns Some(ExitCode::ContractViolation) if __describe is given extra arguments, or if emitting the JSON line fails. Returns Some(ExitCode::Ok) on the happy path.

Trait Implementations

impl Clone for Describe

fn clone(&self) -> Describe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Describe

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Describe

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Describe

fn eq(&self, other: &Describe) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Describe

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Describe

impl StructuralPartialEq for Describe