Struct PluginContext

Source

pub struct PluginContext {
    pub plugin_id: String,
    pub permissions: Vec<Permission>,
    pub data_dir: PathBuf,
    pub config: Value,
}

Expand description

API context provided to plugins

Fields§

§plugin_id: String

Plugin ID

§permissions: Vec<Permission>

Granted permissions

§data_dir: PathBuf

Plugin data directory

§config: Value

Plugin configuration

Implementations§

Source §

impl PluginContext

Source

pub fn has_permission(&self, permission: &Permission) -> bool

Check if plugin has a permission

Source

pub fn get_data_path(&self, filename: &str) -> PathBuf

Get plugin data path

Source

pub fn read_data(&self, filename: &str) -> Result<String>

Read plugin data file

Source

pub fn write_data(&self, filename: &str, content: &str) -> Result<()>

Write plugin data file

Auto Trait Implementations§

§

impl UnwindSafe for PluginContext

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> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §