Struct PluginStore 

pub struct PluginStore { /* private fields */ }

One plugin’s durable key/value store.

Construct through PluginStore::open; share through a PluginStoreHandle. Never fails to open: an unreadable, corrupt or stale file yields an empty store with a debug log.

Implementations

impl PluginStore

pub fn open(dir: &Path) -> Self

Open (or start) the store held in dir — the plugin’s private data directory, so two plugins cannot collide and uninstalling one removes what it persisted.

Never fails. Every unreadable case degrades to an empty store, which the next write repopulates.

pub fn put(&mut self, key: &str, value: Vec<u8>) -> Result<(), String>

Store value under key, bumping generation.

Err only for a value that cannot fit at all; a value that merely does not fit alongside what is there clears the store first and is then stored, because the alternative — refusing the newest write — leaves a full store permanently unable to record the thing it is being asked to remember.

pub fn get(&self, key: &str) -> Option<Vec<u8>>

The bytes under key, or None when nothing is stored there.

pub fn delete(&mut self, key: &str) -> Result<(), String>

Forget key. Deleting what is not there is Ok — a retraction that has already happened is not an error — but it does NOT bump the generation, because nothing changed and a reader that rebuilt for it would be rebuilding for nothing.

pub fn keys(&self, prefix: &str) -> Vec<String>

Keys carrying prefix, sorted. "" lists everything.

pub fn generation(&self) -> u64

The mutation counter a reader compares against what it last built from.

pub fn flush(&mut self)

Write the store out. Best-effort: a failure is logged and dropped, because a store that cannot be written is a store that rebuilds on the next boot — degraded, not wrong.

Written to a temporary file and renamed, so a kill mid-write leaves the previous state intact rather than a truncated file the next boot has to recognise as corrupt.

Trait Implementations

impl Debug for PluginStore

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

Formats the value using the given formatter.

impl Drop for PluginStore

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.