PluginContext

Struct PluginContext 

Source
pub struct PluginContext {
    pub data_dir: PathBuf,
    pub extra: HashMap<String, String>,
    pub config_json: Option<String>,
}
Expand description

Context passed to plugins during execution Provides access to shared resources

Fields§

§data_dir: PathBuf

Path to the data directory

§extra: HashMap<String, String>

Additional context data (plugin-specific)

§config_json: Option<String>

Plugin configuration as JSON string (deserialized by plugin)

Implementations§

Source§

impl PluginContext

Source

pub fn new(data_dir: PathBuf) -> Self

Source

pub fn with_extra( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Source

pub fn with_config(self, config_json: impl Into<String>) -> Self

Source

pub fn get_config<T: DeserializeOwned + Default>(&self) -> T

Deserialize configuration from JSON Returns default if no config is set or parsing fails

Source

pub fn try_get_config<T: DeserializeOwned>(&self) -> PluginResult<Option<T>>

Try to deserialize configuration, returning an error on failure

Trait Implementations§

Source§

impl Debug for PluginContext

Source§

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

Formats the value using the given formatter. 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> 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, 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.