Struct VaultApi 

pub struct VaultApi { /* private fields */ }

Cloneable, curated facade supplied to every plugin.

The host builds one of these PER PLUGIN, bound to that plugin’s identity, so a capability granted to one plugin is not reachable from another.

Implementations

impl VaultApi

pub fn new(host: Arc<dyn VaultHost>, identity: PluginIdentity) -> Self

Wrap a host implementation for one specific plugin.

pub fn identity(&self) -> &PluginIdentity

The calling plugin’s identity, as the host validated it.

pub async fn active_vault(&self) -> PluginResult<VaultDescriptor>

Return the currently selected vault’s identity.

The selection can change between calls. Capture the name once and pass it to subsequent operations rather than re-resolving per call.

pub async fn list_notes(&self, vault: &str) -> PluginResult<Vec<String>>

List markdown note paths in vault.

pub async fn list_notes_detailed( &self, vault: &str, ) -> PluginResult<Vec<NoteListing>>

List notes in vault with change-detection metadata.

The reconciliation half of the change contract: crate::HookBus is the fast path for changes while a plugin is running, and this is how a plugin catches up on everything the feed could not tell it about — changes made while the process was down, and changes lost to crate::HookRecvError::Lagged. Compare each entry against what you stored and re-read only what moved.

pub async fn read_note( &self, vault: &str, path: &str, ) -> PluginResult<NoteSnapshot>

Read a complete note and its opaque version from vault.

pub async fn read_notes( &self, vault: &str, paths: &[String], ) -> PluginResult<Vec<NoteSnapshot>>

Read several notes in one call.

Prefer this to a loop over Self::read_note when reconciling: the host resolves the vault once for the whole batch instead of once per note. Paths that cannot be read are omitted, so a note deleted between listing and reading does not fail the pass.

pub async fn write_note( &self, request: WriteNoteRequest, ) -> PluginResult<WriteReceipt>

Create or compare-and-swap a complete note.

pub async fn read_config( &self, vault: &str, path: &str, ) -> PluginResult<Option<Vec<u8>>>

Read one application-config file this plugin declared it needs.

The note APIs cannot reach .obsidian/ — that space holds code the application executes, so it is not part of the note surface. A plugin that genuinely needs to self-tune to app settings declares the exact files it reads via PluginCapabilities::config_reads, and this method serves only those. Anything else is PluginErrorCode::PermissionDenied.

Returns Ok(None) when a permitted file does not exist.

Trait Implementations

impl Clone for VaultApi

fn clone(&self) -> VaultApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VaultApi

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

Formats the value using the given formatter.