Struct PluginManifest 

pub struct PluginManifest {

    pub schema_version: u32,
    pub id: String,
    pub name: String,
    pub version: String,
    pub author: Option<String>,
    pub license: Option<String>,
    pub description: Option<String>,
    pub kinds: Vec<String>,
    pub activation: PluginActivation,
    pub entry_points: HashMap<String, PluginEntryPoint>,
    pub status_bar_widget: Option<StatusBarWidgetKind>,
    pub actions: Vec<ActionContribution>,
    pub subscriptions: Vec<String>,
    pub restart: RestartPolicy,
    pub overlay: Option<OverlayCapability>,
}

A parsed manifest.json.

Fields

schema_version: u32

Manifest format version; only 1 is understood.

id: String

Reverse-DNS-ish plugin id; must equal the directory name.

name: String

Human-readable name.

version: String

Plugin version, displayed at the enable toggle.

author: Option<String>

Author, displayed at the enable toggle (trust surface).

license: Option<String>

License, displayed at the enable toggle (trust surface).

description: Option<String>

What the plugin does, shown in Settings.

kinds: Vec<String>

Kinds this plugin provides; each must be known to this host.

activation: PluginActivation

When the plugin starts once enabled.

entry_points: HashMap<String, PluginEntryPoint>

Named entry points; the key selects the kind’s executable.

status_bar_widget: Option<StatusBarWidgetKind>

Required iff kinds contains KIND_STATUS_BAR_WIDGET.

actions: Vec<ActionContribution>

Actions contributed to the command palette; required non-empty iff kinds contains KIND_ACTION_CONTRIBUTOR, ignored otherwise.

subscriptions: Vec<String>

Terminal event kinds the plugin wants delivered to its stdin. Empty or absent means self-scheduled: the plugin receives no terminal events (unlike tab scripts, where an empty subscription list means all events). Each name must be one of crate::observer::EVENT_KINDS; an unknown or duplicate name skips the plugin at discovery so a typo’d subscription can never silently never-fire.

restart: RestartPolicy

When the host restarts the plugin’s exited process: on_failure (the default and the only behaviour before the field existed), never, or always — the same policy enum tab scripts configure. Mode-only by design: backoff parameters (restart delay, crash-loop cap) are host-owned safety policy a manifest cannot tune its way out of (parsight decision 95).

overlay: Option<OverlayCapability>

Overlay-kind capability block (phase 2). Absent means display-only: interactive: true requests are forced off at ingest. Present with interactive: true is required before an overlay may focus and render interactive widgets.

Trait Implementations

impl Clone for PluginManifest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginManifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginManifest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PluginManifest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PluginManifest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PluginManifest