Skip to main content

PluginStorage

Struct PluginStorage 

Source
pub struct PluginStorage { /* private fields */ }
Expand description

SQLite-backed per-plugin KV store. Cheap to clone (wraps an Arc).

Implementations§

Source§

impl PluginStorage

Source

pub fn open(path: PathBuf) -> Result<Self>

Open (or create) the store at a specific path and run migrations.

Source

pub fn in_memory() -> Result<Self>

In-memory store for tests.

Source

pub async fn get( &self, plugin_id: &str, namespace: &str, key: &str, ) -> Result<Option<String>>

Read a value. Ok(None) when the key is unset.

Source

pub async fn set( &self, plugin_id: &str, namespace: &str, key: &str, value: &str, ) -> Result<()>

Upsert a value.

Source

pub async fn delete( &self, plugin_id: &str, namespace: &str, key: &str, ) -> Result<()>

Delete a value (no-op if absent).

Source

pub async fn rekey_plugin(&self, from: &str, to: &str) -> Result<usize>

List the keys a plugin has set within a namespace (newest first). Move every row owned by from to to — the plugin-id rename migration.

The KV is keyed (plugin_id, namespace, key), so a plugin whose id changes would otherwise silently lose all of its state: a goal plugin’s active conditions, the learning log, anything a hook stashed. The rows are still there, just unreachable under the new id, which reads to a user as data loss with no error anywhere.

INSERT OR IGNORE + DELETE rather than UPDATE: if the new id already has a row at the same (namespace, key) — a re-run, or a fresh install that already wrote state — the NEW value wins and the stale legacy row is dropped. A bare UPDATE would fail the primary-key constraint and abort the whole migration on the one plugin that needed it least.

Returns the number of legacy rows removed.

§Errors

Returns Err if the SQLite transaction fails.

Source

pub async fn keys( &self, plugin_id: &str, namespace: &str, ) -> Result<Vec<String>>

Trait Implementations§

Source§

impl Clone for PluginStorage

Source§

fn clone(&self) -> PluginStorage

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

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.