Skip to main content

PluginManifest

Struct PluginManifest 

Source
pub struct PluginManifest {
    pub id: String,
    pub requested: Vec<Capability>,
    pub editor_capabilities: CapabilitySet,
    pub provides: Vec<PluginSeam>,
    pub doc: Option<String>,
    pub default_modes: Vec<String>,
}
Expand description

Everything a plugin declares about itself and what it needs. Untrusted input; the trust tier is supplied separately at grant time.

Fields§

§id: String

Stable, human-legible plugin id (fuzzy-finder). Keys the per-plugin data dir (<config-home>/lattice/plugins/<name>/data/). Distinct from the host-issued numeric crate::PluginId used for compact provenance.

§requested: Vec<Capability>

The OS capabilities the plugin requests (its WASI view).

§editor_capabilities: CapabilitySet

The editor capabilities a plugin-declared mode requires (fragment §6).

§provides: Vec<PluginSeam>

The extension seam(s) this plugin’s component implements — which spawn_* path(s) the loader drives. Empty ⇒ lifecycle-only (base plugin world). Programmatic new defaults this empty; disk discovery reads it from the manifest provides list.

§doc: Option<String>

PI.4: the plugin’s own documentation, shown by :describe-plugin. A static, author-written string (immutable at editor runtime). The preferred doc source is the plugin’s embedded WIT world doc-comment; this manifest field is the fallback when a component ships no WIT docs.

§default_modes: Vec<String>

PM.3: the minor modes this plugin enables by DEFAULT. When non-empty the loader auto-registers a <id>.enabled bool option (default true) that gates them — on load (and on any change to the option) the manager enables / disables each via the ModeEnablementRequested path. Empty ⇒ every mode the plugin contributes must be enabled explicitly (the CI.3 available-but-off default). The host learns the mode-ids ONLY from here — the plugin owns them (mode-ownership).

OC.1a made this plural. A plugin with more than one on-by-default mode could not express itself: org contributes org-todo-mode (org files) and org-global-mode (the universal <C-x>o prefix), and naming one left the other registered, correct, and permanently inert — a chord that silently does nothing, with the enablement filter the only place that would have explained it. The singular default_mode key is still accepted and folds in here; a manifest may use either or both.

Implementations§

Source§

impl PluginManifest

Source

pub fn new( id: impl Into<String>, requested: Vec<Capability>, editor_capabilities: CapabilitySet, ) -> Self

Construct a manifest programmatically (the host’s typed entry point).

Source

pub fn from_toml_str(text: &str) -> Result<Self, ManifestError>

Parse a manifest from its TOML text, validating every capability form. A malformed capability / editor-capability / empty id is a typed ManifestError, never a panic.

Trait Implementations§

Source§

impl Clone for PluginManifest

Source§

fn clone(&self) -> PluginManifest

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PluginManifest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PluginManifest

Source§

impl PartialEq for PluginManifest

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PluginManifest

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Pointer = u32

§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more