Struct PluginState 

pub struct PluginState {
    pub plugins: HashMap<String, PluginStateEntry>,
}

Top-level plugin state file, stored at {data_dir}/plugin-state.json.

Fields

plugins: HashMap<String, PluginStateEntry>

Implementations

impl PluginState

pub fn load(data_dir: &Path) -> Self

Load plugin state from a data directory. Returns default (empty) if the file doesn’t exist or can’t be parsed.

pub fn save(&self, data_dir: &Path) -> Result<()>

Save plugin state to a data directory.

pub fn is_enabled(&self, id: &str) -> bool

Check whether a plugin is enabled. Returns true if the plugin has no state entry (default is enabled).

pub fn enable(&mut self, id: &str) -> Result<()>

Enable a plugin. Creates an entry if one doesn’t exist.

pub fn disable(&mut self, id: &str) -> Result<()>

Disable a plugin. Creates an entry if one doesn’t exist.

pub fn record_install(&mut self, id: &str, version: &str, source: &str)

Record that a plugin was installed.

pub fn remove(&mut self, id: &str)

Remove a plugin’s state entry.

Trait Implementations

impl Clone for PluginState

fn clone(&self) -> PluginState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginState

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

Formats the value using the given formatter.

impl Default for PluginState

fn default() -> PluginState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.