Struct Plugin

pub struct Plugin<S>
where
    S: Clone + Send,
{ /* private fields */ }

Implementations

impl<S> Plugin<S>

where S: Clone + Send,

pub fn option_str(&self, name: &str) -> Result<Option<Value>>

pub fn option<'a, OV: OptionType<'a>>( &self, config_option: &ConfigOption<'a, OV>, ) -> Result<OV::OutputValue>

pub fn set_option_str(&self, name: &str, value: Value) -> Result<()>

pub fn set_option<'a, OV: OptionType<'a>>( &self, config_option: &ConfigOption<'a, OV>, value: Value, ) -> Result<()>

impl<S> Plugin<S>

where S: Clone + Send,

pub fn options(&self) -> Vec<UntypedConfigOption>

pub fn configuration(&self) -> Configuration

pub fn state(&self) -> &S

impl<S> Plugin<S>

where S: Send + Clone,

pub async fn send_custom_notification( &self, method: String, v: Value, ) -> Result<(), Error>

pub async fn join(&self) -> Result<(), Error>

Wait for plugin shutdown

pub fn shutdown(&self) -> Result<(), Error>

Request plugin shutdown

Trait Implementations

impl<S> Clone for Plugin<S>

where S: Clone + Send + Clone,

fn clone(&self) -> Plugin<S>

Returns a copy of the value.

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

Performs copy-assignment from source.