Struct SidecarLifecycle 

pub struct SidecarLifecycle {
    pub command: String,
    pub settings_category: Option<String>,
    pub display_name: Option<String>,
    pub importance: i32,
}

Plugin-claimed lifecycle UX for a sidecar. See SidecarManifest::lifecycle.

The plugin chooses how its lifecycle commands and settings appear to the user. Core uses display_name for the pill, status line, and error messages; auto-registers <command> toggle/status as addressable slash commands; injects a virtual toggle-key field into settings_category (when given).

importance controls pill ordering when multiple sidecars are loaded simultaneously: higher = leftmost. Defaults to 0. Cap at -100..=100; values outside that range are clamped at parse time.

Fields

command: String

Slash-command name that owns this sidecar’s lifecycle. Together with toggle/status subcommands forms e.g. the plugin’s toggle command.

settings_category: Option<String>

Settings category id (matches a settings.categories[].id in the plugin manifest) that should host the virtual toggle-key field. When None, no settings injection happens.

display_name: Option<String>

Display name shown in the pill, status line, and /extensions (e.g. “Sample”, “OCR”). Defaults to command when None.

importance: i32

Pill-ordering hint (-100..=100, default 0). Higher = leftmost.

Implementations

impl SidecarLifecycle

pub fn effective_display_name(&self) -> &str

Resolved display name: display_name if set, else command.

Trait Implementations

impl Clone for SidecarLifecycle

fn clone(&self) -> SidecarLifecycle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SidecarLifecycle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SidecarLifecycle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SidecarLifecycle

fn eq(&self, other: &SidecarLifecycle) -> 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 Eq for SidecarLifecycle

impl StructuralPartialEq for SidecarLifecycle