Struct PluginCapabilities 

#[non_exhaustive]
pub struct PluginCapabilities {
    pub config_reads: Vec<String>,
}

What a plugin declares it needs beyond the note APIs.

Capabilities are declared by the plugin crate rather than listed centrally in this crate: the plugin owns the integration and therefore knows exactly what it reads, and a central list would duplicate that knowledge and drift from it. The default grants nothing — a plugin that declares nothing gets only the note surface every plugin gets.

The host validates a declaration at mount time, so an over-broad or malformed request stops the server from starting instead of surfacing as a confusing runtime denial.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

config_reads: Vec<String>

Exact vault-relative application-config files this plugin may read, for example .obsidian/plugins/obsidian-tasks-plugin/data.json.

Exact paths, not directory prefixes: a reviewer can see precisely what a plugin reads, and granting a whole plugin folder would hand over files nobody enumerated. A directory-scoped form can be added later if a real plugin needs genuinely dynamic file names.

Implementations

impl PluginCapabilities

pub fn none() -> Self

A declaration granting nothing beyond the note APIs.

pub fn with_config_read(self, path: impl Into<String>) -> Self

Declare one exact readable config path.

pub fn validate(&self) -> PluginResult<()>

Validate every declared capability.

Declarations are normalized on the way in, so a plugin cannot declare .obsidian/../.git/config and have it accepted, and cannot declare a path in one spelling then request it in another.

Trait Implementations

impl Clone for PluginCapabilities

fn clone(&self) -> PluginCapabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginCapabilities

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

Formats the value using the given formatter.

impl Default for PluginCapabilities

fn default() -> PluginCapabilities

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginCapabilities

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PluginCapabilities

impl PartialEq for PluginCapabilities

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PluginCapabilities

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 PluginCapabilities